Constructor Detail

• UsageMetadata.Builder

  UsageMetadata.Builder()

Method Detail

• promptTokenCount

   abstract UsageMetadata.Builder promptTokenCount(Integer promptTokenCount)

  Setter for promptTokenCount.

  promptTokenCount: Number of tokens in the prompt. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.

• clearPromptTokenCount

  @CanIgnoreReturnValue() UsageMetadata.Builder clearPromptTokenCount()

  Clears the value of promptTokenCount field.

• cachedContentTokenCount

   abstract UsageMetadata.Builder cachedContentTokenCount(Integer cachedContentTokenCount)

  Setter for cachedContentTokenCount.

  cachedContentTokenCount: Number of tokens in the cached part of the prompt (the cached content).

• clearCachedContentTokenCount

  @CanIgnoreReturnValue() UsageMetadata.Builder clearCachedContentTokenCount()

  Clears the value of cachedContentTokenCount field.

• responseTokenCount

   abstract UsageMetadata.Builder responseTokenCount(Integer responseTokenCount)

  Setter for responseTokenCount.

  responseTokenCount: Total number of tokens across all the generated response candidates.

• clearResponseTokenCount

  @CanIgnoreReturnValue() UsageMetadata.Builder clearResponseTokenCount()

  Clears the value of responseTokenCount field.

• toolUsePromptTokenCount

   abstract UsageMetadata.Builder toolUsePromptTokenCount(Integer toolUsePromptTokenCount)

  Setter for toolUsePromptTokenCount.

  toolUsePromptTokenCount: Number of tokens present in tool-use prompt(s).

• clearToolUsePromptTokenCount

  @CanIgnoreReturnValue() UsageMetadata.Builder clearToolUsePromptTokenCount()

  Clears the value of toolUsePromptTokenCount field.

• thoughtsTokenCount

   abstract UsageMetadata.Builder thoughtsTokenCount(Integer thoughtsTokenCount)

  Setter for thoughtsTokenCount.

  thoughtsTokenCount: Number of tokens of thoughts for thinking models.

• clearThoughtsTokenCount

  @CanIgnoreReturnValue() UsageMetadata.Builder clearThoughtsTokenCount()

  Clears the value of thoughtsTokenCount field.

• totalTokenCount

   abstract UsageMetadata.Builder totalTokenCount(Integer totalTokenCount)

  Setter for totalTokenCount.

  totalTokenCount: Total token count for prompt, response candidates, and tool-use prompts(if present).

• clearTotalTokenCount

  @CanIgnoreReturnValue() UsageMetadata.Builder clearTotalTokenCount()

  Clears the value of totalTokenCount field.

• promptTokensDetails

   abstract UsageMetadata.Builder promptTokensDetails(List<ModalityTokenCount> promptTokensDetails)

  Setter for promptTokensDetails.

  promptTokensDetails: List of modalities that were processed in the request input.

• promptTokensDetails

  @CanIgnoreReturnValue() UsageMetadata.Builder promptTokensDetails(Array<ModalityTokenCount> promptTokensDetails)

  Setter for promptTokensDetails.

  promptTokensDetails: List of modalities that were processed in the request input.

• promptTokensDetails

  @CanIgnoreReturnValue() UsageMetadata.Builder promptTokensDetails(Array<ModalityTokenCount.Builder> promptTokensDetailsBuilders)

  Setter for promptTokensDetails builder.

  promptTokensDetails: List of modalities that were processed in the request input.

• clearPromptTokensDetails

  @CanIgnoreReturnValue() UsageMetadata.Builder clearPromptTokensDetails()

  Clears the value of promptTokensDetails field.

• cacheTokensDetails

   abstract UsageMetadata.Builder cacheTokensDetails(List<ModalityTokenCount> cacheTokensDetails)

  Setter for cacheTokensDetails.

  cacheTokensDetails: List of modalities that were processed in the cache input.

• cacheTokensDetails

  @CanIgnoreReturnValue() UsageMetadata.Builder cacheTokensDetails(Array<ModalityTokenCount> cacheTokensDetails)

  Setter for cacheTokensDetails.

  cacheTokensDetails: List of modalities that were processed in the cache input.

• cacheTokensDetails

  @CanIgnoreReturnValue() UsageMetadata.Builder cacheTokensDetails(Array<ModalityTokenCount.Builder> cacheTokensDetailsBuilders)

  Setter for cacheTokensDetails builder.

  cacheTokensDetails: List of modalities that were processed in the cache input.

• clearCacheTokensDetails

  @CanIgnoreReturnValue() UsageMetadata.Builder clearCacheTokensDetails()

  Clears the value of cacheTokensDetails field.

• responseTokensDetails

   abstract UsageMetadata.Builder responseTokensDetails(List<ModalityTokenCount> responseTokensDetails)

  Setter for responseTokensDetails.

  responseTokensDetails: List of modalities that were returned in the response.

• responseTokensDetails

  @CanIgnoreReturnValue() UsageMetadata.Builder responseTokensDetails(Array<ModalityTokenCount> responseTokensDetails)

  Setter for responseTokensDetails.

  responseTokensDetails: List of modalities that were returned in the response.

• responseTokensDetails

  @CanIgnoreReturnValue() UsageMetadata.Builder responseTokensDetails(Array<ModalityTokenCount.Builder> responseTokensDetailsBuilders)

  Setter for responseTokensDetails builder.

  responseTokensDetails: List of modalities that were returned in the response.

• clearResponseTokensDetails

  @CanIgnoreReturnValue() UsageMetadata.Builder clearResponseTokensDetails()

  Clears the value of responseTokensDetails field.

• toolUsePromptTokensDetails

   abstract UsageMetadata.Builder toolUsePromptTokensDetails(List<ModalityTokenCount> toolUsePromptTokensDetails)

  Setter for toolUsePromptTokensDetails.

  toolUsePromptTokensDetails: List of modalities that were processed in the tool-use prompt.

• toolUsePromptTokensDetails

  @CanIgnoreReturnValue() UsageMetadata.Builder toolUsePromptTokensDetails(Array<ModalityTokenCount> toolUsePromptTokensDetails)

  Setter for toolUsePromptTokensDetails.

  toolUsePromptTokensDetails: List of modalities that were processed in the tool-use prompt.

• toolUsePromptTokensDetails

  @CanIgnoreReturnValue() UsageMetadata.Builder toolUsePromptTokensDetails(Array<ModalityTokenCount.Builder> toolUsePromptTokensDetailsBuilders)

  Setter for toolUsePromptTokensDetails builder.

  toolUsePromptTokensDetails: List of modalities that were processed in the tool-use prompt.

• clearToolUsePromptTokensDetails

  @CanIgnoreReturnValue() UsageMetadata.Builder clearToolUsePromptTokensDetails()

  Clears the value of toolUsePromptTokensDetails field.

• trafficType

   abstract UsageMetadata.Builder trafficType(TrafficType trafficType)

  Setter for trafficType.

  trafficType: Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota.

• clearTrafficType

  @CanIgnoreReturnValue() UsageMetadata.Builder clearTrafficType()

  Clears the value of trafficType field.

• trafficType

  @CanIgnoreReturnValue() UsageMetadata.Builder trafficType(TrafficType.Known knownType)

  Setter for trafficType given a known enum.

  trafficType: Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota.

• trafficType

  @CanIgnoreReturnValue() UsageMetadata.Builder trafficType(String trafficType)

  Setter for trafficType given a string.

  trafficType: Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota.

• build

   abstract UsageMetadata build()