public static final class UsageMetadata.Builder extends com.google.protobuf.GeneratedMessage.Builder<UsageMetadata.Builder> implements UsageMetadataOrBuilder
Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.Protobuf type
google.cloud.aiplatform.v1.UsageMetadataaddRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<UsageMetadata.Builder>public UsageMetadata.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessage.Builder<UsageMetadata.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<UsageMetadata.Builder>public UsageMetadata getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic UsageMetadata build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic UsageMetadata buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic UsageMetadata.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<UsageMetadata.Builder>public UsageMetadata.Builder mergeFrom(UsageMetadata other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessage.Builder<UsageMetadata.Builder>public UsageMetadata.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<UsageMetadata.Builder>IOExceptionpublic int getPromptTokenCount()
The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.
int32 prompt_token_count = 1;getPromptTokenCount in interface UsageMetadataOrBuilderpublic UsageMetadata.Builder setPromptTokenCount(int value)
The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.
int32 prompt_token_count = 1;value - The promptTokenCount to set.public UsageMetadata.Builder clearPromptTokenCount()
The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.
int32 prompt_token_count = 1;public int getCandidatesTokenCount()
The total number of tokens in the generated candidates.
int32 candidates_token_count = 2;getCandidatesTokenCount in interface UsageMetadataOrBuilderpublic UsageMetadata.Builder setCandidatesTokenCount(int value)
The total number of tokens in the generated candidates.
int32 candidates_token_count = 2;value - The candidatesTokenCount to set.public UsageMetadata.Builder clearCandidatesTokenCount()
The total number of tokens in the generated candidates.
int32 candidates_token_count = 2;public int getTotalTokenCount()
The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.
int32 total_token_count = 3;getTotalTokenCount in interface UsageMetadataOrBuilderpublic UsageMetadata.Builder setTotalTokenCount(int value)
The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.
int32 total_token_count = 3;value - The totalTokenCount to set.public UsageMetadata.Builder clearTotalTokenCount()
The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.
int32 total_token_count = 3;public int getToolUsePromptTokenCount()
Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.
int32 tool_use_prompt_token_count = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
getToolUsePromptTokenCount in interface UsageMetadataOrBuilderpublic UsageMetadata.Builder setToolUsePromptTokenCount(int value)
Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.
int32 tool_use_prompt_token_count = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The toolUsePromptTokenCount to set.public UsageMetadata.Builder clearToolUsePromptTokenCount()
Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.
int32 tool_use_prompt_token_count = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
public int getThoughtsTokenCount()
Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable.
int32 thoughts_token_count = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];getThoughtsTokenCount in interface UsageMetadataOrBuilderpublic UsageMetadata.Builder setThoughtsTokenCount(int value)
Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable.
int32 thoughts_token_count = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];value - The thoughtsTokenCount to set.public UsageMetadata.Builder clearThoughtsTokenCount()
Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable.
int32 thoughts_token_count = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];public int getCachedContentTokenCount()
Output only. The number of tokens in the cached content that was used for this request.
int32 cached_content_token_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCachedContentTokenCount in interface UsageMetadataOrBuilderpublic UsageMetadata.Builder setCachedContentTokenCount(int value)
Output only. The number of tokens in the cached content that was used for this request.
int32 cached_content_token_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The cachedContentTokenCount to set.public UsageMetadata.Builder clearCachedContentTokenCount()
Output only. The number of tokens in the cached content that was used for this request.
int32 cached_content_token_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public List<ModalityTokenCount> getPromptTokensDetailsList()
Output only. A detailed breakdown of the token count for each modality in the prompt.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount prompt_tokens_details = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getPromptTokensDetailsList in interface UsageMetadataOrBuilderpublic int getPromptTokensDetailsCount()
Output only. A detailed breakdown of the token count for each modality in the prompt.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount prompt_tokens_details = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getPromptTokensDetailsCount in interface UsageMetadataOrBuilderpublic ModalityTokenCount getPromptTokensDetails(int index)
Output only. A detailed breakdown of the token count for each modality in the prompt.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount prompt_tokens_details = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getPromptTokensDetails in interface UsageMetadataOrBuilderpublic UsageMetadata.Builder setPromptTokensDetails(int index, ModalityTokenCount value)
Output only. A detailed breakdown of the token count for each modality in the prompt.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount prompt_tokens_details = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder setPromptTokensDetails(int index, ModalityTokenCount.Builder builderForValue)
Output only. A detailed breakdown of the token count for each modality in the prompt.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount prompt_tokens_details = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder addPromptTokensDetails(ModalityTokenCount value)
Output only. A detailed breakdown of the token count for each modality in the prompt.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount prompt_tokens_details = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder addPromptTokensDetails(int index, ModalityTokenCount value)
Output only. A detailed breakdown of the token count for each modality in the prompt.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount prompt_tokens_details = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder addPromptTokensDetails(ModalityTokenCount.Builder builderForValue)
Output only. A detailed breakdown of the token count for each modality in the prompt.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount prompt_tokens_details = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder addPromptTokensDetails(int index, ModalityTokenCount.Builder builderForValue)
Output only. A detailed breakdown of the token count for each modality in the prompt.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount prompt_tokens_details = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder addAllPromptTokensDetails(Iterable<? extends ModalityTokenCount> values)
Output only. A detailed breakdown of the token count for each modality in the prompt.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount prompt_tokens_details = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder clearPromptTokensDetails()
Output only. A detailed breakdown of the token count for each modality in the prompt.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount prompt_tokens_details = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder removePromptTokensDetails(int index)
Output only. A detailed breakdown of the token count for each modality in the prompt.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount prompt_tokens_details = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
public ModalityTokenCount.Builder getPromptTokensDetailsBuilder(int index)
Output only. A detailed breakdown of the token count for each modality in the prompt.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount prompt_tokens_details = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
public ModalityTokenCountOrBuilder getPromptTokensDetailsOrBuilder(int index)
Output only. A detailed breakdown of the token count for each modality in the prompt.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount prompt_tokens_details = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getPromptTokensDetailsOrBuilder in interface UsageMetadataOrBuilderpublic List<? extends ModalityTokenCountOrBuilder> getPromptTokensDetailsOrBuilderList()
Output only. A detailed breakdown of the token count for each modality in the prompt.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount prompt_tokens_details = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getPromptTokensDetailsOrBuilderList in interface UsageMetadataOrBuilderpublic ModalityTokenCount.Builder addPromptTokensDetailsBuilder()
Output only. A detailed breakdown of the token count for each modality in the prompt.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount prompt_tokens_details = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
public ModalityTokenCount.Builder addPromptTokensDetailsBuilder(int index)
Output only. A detailed breakdown of the token count for each modality in the prompt.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount prompt_tokens_details = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
public List<ModalityTokenCount.Builder> getPromptTokensDetailsBuilderList()
Output only. A detailed breakdown of the token count for each modality in the prompt.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount prompt_tokens_details = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
public List<ModalityTokenCount> getCacheTokensDetailsList()
Output only. A detailed breakdown of the token count for each modality in the cached content.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount cache_tokens_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCacheTokensDetailsList in interface UsageMetadataOrBuilderpublic int getCacheTokensDetailsCount()
Output only. A detailed breakdown of the token count for each modality in the cached content.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount cache_tokens_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCacheTokensDetailsCount in interface UsageMetadataOrBuilderpublic ModalityTokenCount getCacheTokensDetails(int index)
Output only. A detailed breakdown of the token count for each modality in the cached content.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount cache_tokens_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCacheTokensDetails in interface UsageMetadataOrBuilderpublic UsageMetadata.Builder setCacheTokensDetails(int index, ModalityTokenCount value)
Output only. A detailed breakdown of the token count for each modality in the cached content.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount cache_tokens_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder setCacheTokensDetails(int index, ModalityTokenCount.Builder builderForValue)
Output only. A detailed breakdown of the token count for each modality in the cached content.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount cache_tokens_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder addCacheTokensDetails(ModalityTokenCount value)
Output only. A detailed breakdown of the token count for each modality in the cached content.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount cache_tokens_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder addCacheTokensDetails(int index, ModalityTokenCount value)
Output only. A detailed breakdown of the token count for each modality in the cached content.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount cache_tokens_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder addCacheTokensDetails(ModalityTokenCount.Builder builderForValue)
Output only. A detailed breakdown of the token count for each modality in the cached content.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount cache_tokens_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder addCacheTokensDetails(int index, ModalityTokenCount.Builder builderForValue)
Output only. A detailed breakdown of the token count for each modality in the cached content.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount cache_tokens_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder addAllCacheTokensDetails(Iterable<? extends ModalityTokenCount> values)
Output only. A detailed breakdown of the token count for each modality in the cached content.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount cache_tokens_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder clearCacheTokensDetails()
Output only. A detailed breakdown of the token count for each modality in the cached content.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount cache_tokens_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder removeCacheTokensDetails(int index)
Output only. A detailed breakdown of the token count for each modality in the cached content.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount cache_tokens_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
public ModalityTokenCount.Builder getCacheTokensDetailsBuilder(int index)
Output only. A detailed breakdown of the token count for each modality in the cached content.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount cache_tokens_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
public ModalityTokenCountOrBuilder getCacheTokensDetailsOrBuilder(int index)
Output only. A detailed breakdown of the token count for each modality in the cached content.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount cache_tokens_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCacheTokensDetailsOrBuilder in interface UsageMetadataOrBuilderpublic List<? extends ModalityTokenCountOrBuilder> getCacheTokensDetailsOrBuilderList()
Output only. A detailed breakdown of the token count for each modality in the cached content.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount cache_tokens_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCacheTokensDetailsOrBuilderList in interface UsageMetadataOrBuilderpublic ModalityTokenCount.Builder addCacheTokensDetailsBuilder()
Output only. A detailed breakdown of the token count for each modality in the cached content.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount cache_tokens_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
public ModalityTokenCount.Builder addCacheTokensDetailsBuilder(int index)
Output only. A detailed breakdown of the token count for each modality in the cached content.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount cache_tokens_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
public List<ModalityTokenCount.Builder> getCacheTokensDetailsBuilderList()
Output only. A detailed breakdown of the token count for each modality in the cached content.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount cache_tokens_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
public List<ModalityTokenCount> getCandidatesTokensDetailsList()
Output only. A detailed breakdown of the token count for each modality in the generated candidates.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount candidates_tokens_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCandidatesTokensDetailsList in interface UsageMetadataOrBuilderpublic int getCandidatesTokensDetailsCount()
Output only. A detailed breakdown of the token count for each modality in the generated candidates.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount candidates_tokens_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCandidatesTokensDetailsCount in interface UsageMetadataOrBuilderpublic ModalityTokenCount getCandidatesTokensDetails(int index)
Output only. A detailed breakdown of the token count for each modality in the generated candidates.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount candidates_tokens_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCandidatesTokensDetails in interface UsageMetadataOrBuilderpublic UsageMetadata.Builder setCandidatesTokensDetails(int index, ModalityTokenCount value)
Output only. A detailed breakdown of the token count for each modality in the generated candidates.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount candidates_tokens_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder setCandidatesTokensDetails(int index, ModalityTokenCount.Builder builderForValue)
Output only. A detailed breakdown of the token count for each modality in the generated candidates.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount candidates_tokens_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder addCandidatesTokensDetails(ModalityTokenCount value)
Output only. A detailed breakdown of the token count for each modality in the generated candidates.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount candidates_tokens_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder addCandidatesTokensDetails(int index, ModalityTokenCount value)
Output only. A detailed breakdown of the token count for each modality in the generated candidates.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount candidates_tokens_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder addCandidatesTokensDetails(ModalityTokenCount.Builder builderForValue)
Output only. A detailed breakdown of the token count for each modality in the generated candidates.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount candidates_tokens_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder addCandidatesTokensDetails(int index, ModalityTokenCount.Builder builderForValue)
Output only. A detailed breakdown of the token count for each modality in the generated candidates.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount candidates_tokens_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder addAllCandidatesTokensDetails(Iterable<? extends ModalityTokenCount> values)
Output only. A detailed breakdown of the token count for each modality in the generated candidates.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount candidates_tokens_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder clearCandidatesTokensDetails()
Output only. A detailed breakdown of the token count for each modality in the generated candidates.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount candidates_tokens_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder removeCandidatesTokensDetails(int index)
Output only. A detailed breakdown of the token count for each modality in the generated candidates.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount candidates_tokens_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
public ModalityTokenCount.Builder getCandidatesTokensDetailsBuilder(int index)
Output only. A detailed breakdown of the token count for each modality in the generated candidates.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount candidates_tokens_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
public ModalityTokenCountOrBuilder getCandidatesTokensDetailsOrBuilder(int index)
Output only. A detailed breakdown of the token count for each modality in the generated candidates.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount candidates_tokens_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCandidatesTokensDetailsOrBuilder in interface UsageMetadataOrBuilderpublic List<? extends ModalityTokenCountOrBuilder> getCandidatesTokensDetailsOrBuilderList()
Output only. A detailed breakdown of the token count for each modality in the generated candidates.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount candidates_tokens_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCandidatesTokensDetailsOrBuilderList in interface UsageMetadataOrBuilderpublic ModalityTokenCount.Builder addCandidatesTokensDetailsBuilder()
Output only. A detailed breakdown of the token count for each modality in the generated candidates.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount candidates_tokens_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
public ModalityTokenCount.Builder addCandidatesTokensDetailsBuilder(int index)
Output only. A detailed breakdown of the token count for each modality in the generated candidates.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount candidates_tokens_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
public List<ModalityTokenCount.Builder> getCandidatesTokensDetailsBuilderList()
Output only. A detailed breakdown of the token count for each modality in the generated candidates.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount candidates_tokens_details = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
public List<ModalityTokenCount> getToolUsePromptTokensDetailsList()
Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getToolUsePromptTokensDetailsList in interface UsageMetadataOrBuilderpublic int getToolUsePromptTokensDetailsCount()
Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getToolUsePromptTokensDetailsCount in interface UsageMetadataOrBuilderpublic ModalityTokenCount getToolUsePromptTokensDetails(int index)
Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getToolUsePromptTokensDetails in interface UsageMetadataOrBuilderpublic UsageMetadata.Builder setToolUsePromptTokensDetails(int index, ModalityTokenCount value)
Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder setToolUsePromptTokensDetails(int index, ModalityTokenCount.Builder builderForValue)
Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder addToolUsePromptTokensDetails(ModalityTokenCount value)
Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder addToolUsePromptTokensDetails(int index, ModalityTokenCount value)
Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder addToolUsePromptTokensDetails(ModalityTokenCount.Builder builderForValue)
Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder addToolUsePromptTokensDetails(int index, ModalityTokenCount.Builder builderForValue)
Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder addAllToolUsePromptTokensDetails(Iterable<? extends ModalityTokenCount> values)
Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder clearToolUsePromptTokensDetails()
Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public UsageMetadata.Builder removeToolUsePromptTokensDetails(int index)
Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public ModalityTokenCount.Builder getToolUsePromptTokensDetailsBuilder(int index)
Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public ModalityTokenCountOrBuilder getToolUsePromptTokensDetailsOrBuilder(int index)
Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getToolUsePromptTokensDetailsOrBuilder in interface UsageMetadataOrBuilderpublic List<? extends ModalityTokenCountOrBuilder> getToolUsePromptTokensDetailsOrBuilderList()
Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getToolUsePromptTokensDetailsOrBuilderList in interface UsageMetadataOrBuilderpublic ModalityTokenCount.Builder addToolUsePromptTokensDetailsBuilder()
Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public ModalityTokenCount.Builder addToolUsePromptTokensDetailsBuilder(int index)
Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public List<ModalityTokenCount.Builder> getToolUsePromptTokensDetailsBuilderList()
Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
repeated .google.cloud.aiplatform.v1.ModalityTokenCount tool_use_prompt_tokens_details = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public int getTrafficTypeValue()
Output only. The traffic type for this request.
.google.cloud.aiplatform.v1.UsageMetadata.TrafficType traffic_type = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getTrafficTypeValue in interface UsageMetadataOrBuilderpublic UsageMetadata.Builder setTrafficTypeValue(int value)
Output only. The traffic type for this request.
.google.cloud.aiplatform.v1.UsageMetadata.TrafficType traffic_type = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The enum numeric value on the wire for trafficType to set.public UsageMetadata.TrafficType getTrafficType()
Output only. The traffic type for this request.
.google.cloud.aiplatform.v1.UsageMetadata.TrafficType traffic_type = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getTrafficType in interface UsageMetadataOrBuilderpublic UsageMetadata.Builder setTrafficType(UsageMetadata.TrafficType value)
Output only. The traffic type for this request.
.google.cloud.aiplatform.v1.UsageMetadata.TrafficType traffic_type = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The trafficType to set.public UsageMetadata.Builder clearTrafficType()
Output only. The traffic type for this request.
.google.cloud.aiplatform.v1.UsageMetadata.TrafficType traffic_type = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Copyright © 2026 Google LLC. All rights reserved.