Package com.google.genai.types

Class UsageMetadata.Builder

java.lang.Object
com.google.genai.types.UsageMetadata.Builder
Enclosing class:
UsageMetadata
public abstract static class UsageMetadata.Builder extends Object
Builder for UsageMetadata.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • promptTokenCount

      public 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 public UsageMetadata.Builder clearPromptTokenCount()
      Clears the value of promptTokenCount field.

    • cachedContentTokenCount

      public 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 public UsageMetadata.Builder clearCachedContentTokenCount()
      Clears the value of cachedContentTokenCount field.

    • responseTokenCount

      public abstract UsageMetadata.Builder responseTokenCount(Integer responseTokenCount)
      Setter for responseTokenCount.

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

    • clearResponseTokenCount

      @CanIgnoreReturnValue public UsageMetadata.Builder clearResponseTokenCount()
      Clears the value of responseTokenCount field.

    • toolUsePromptTokenCount

      public abstract UsageMetadata.Builder toolUsePromptTokenCount(Integer toolUsePromptTokenCount)
      Setter for toolUsePromptTokenCount.

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

    • clearToolUsePromptTokenCount

      @CanIgnoreReturnValue public UsageMetadata.Builder clearToolUsePromptTokenCount()
      Clears the value of toolUsePromptTokenCount field.

    • thoughtsTokenCount

      public abstract UsageMetadata.Builder thoughtsTokenCount(Integer thoughtsTokenCount)
      Setter for thoughtsTokenCount.

      thoughtsTokenCount: Number of tokens of thoughts for thinking models.

    • clearThoughtsTokenCount

      @CanIgnoreReturnValue public UsageMetadata.Builder clearThoughtsTokenCount()
      Clears the value of thoughtsTokenCount field.

    • totalTokenCount

      public 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 public UsageMetadata.Builder clearTotalTokenCount()
      Clears the value of totalTokenCount field.

    • promptTokensDetails

      public abstract UsageMetadata.Builder promptTokensDetails(List<ModalityTokenCount> promptTokensDetails)
      Setter for promptTokensDetails.

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

    • promptTokensDetails

      @CanIgnoreReturnValue public UsageMetadata.Builder promptTokensDetails(ModalityTokenCount... promptTokensDetails)
      Setter for promptTokensDetails.

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

    • promptTokensDetails

      @CanIgnoreReturnValue public UsageMetadata.Builder promptTokensDetails(ModalityTokenCount.Builder... promptTokensDetailsBuilders)
      Setter for promptTokensDetails builder.

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

    • clearPromptTokensDetails

      @CanIgnoreReturnValue public UsageMetadata.Builder clearPromptTokensDetails()
      Clears the value of promptTokensDetails field.

    • cacheTokensDetails

      public abstract UsageMetadata.Builder cacheTokensDetails(List<ModalityTokenCount> cacheTokensDetails)
      Setter for cacheTokensDetails.

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

    • cacheTokensDetails

      @CanIgnoreReturnValue public UsageMetadata.Builder cacheTokensDetails(ModalityTokenCount... cacheTokensDetails)
      Setter for cacheTokensDetails.

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

    • cacheTokensDetails

      @CanIgnoreReturnValue public UsageMetadata.Builder cacheTokensDetails(ModalityTokenCount.Builder... cacheTokensDetailsBuilders)
      Setter for cacheTokensDetails builder.

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

    • clearCacheTokensDetails

      @CanIgnoreReturnValue public UsageMetadata.Builder clearCacheTokensDetails()
      Clears the value of cacheTokensDetails field.

    • responseTokensDetails

      public abstract UsageMetadata.Builder responseTokensDetails(List<ModalityTokenCount> responseTokensDetails)
      Setter for responseTokensDetails.

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

    • responseTokensDetails

      @CanIgnoreReturnValue public UsageMetadata.Builder responseTokensDetails(ModalityTokenCount... responseTokensDetails)
      Setter for responseTokensDetails.

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

    • responseTokensDetails

      @CanIgnoreReturnValue public UsageMetadata.Builder responseTokensDetails(ModalityTokenCount.Builder... responseTokensDetailsBuilders)
      Setter for responseTokensDetails builder.

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

    • clearResponseTokensDetails

      @CanIgnoreReturnValue public UsageMetadata.Builder clearResponseTokensDetails()
      Clears the value of responseTokensDetails field.

    • toolUsePromptTokensDetails

      public abstract UsageMetadata.Builder toolUsePromptTokensDetails(List<ModalityTokenCount> toolUsePromptTokensDetails)
      Setter for toolUsePromptTokensDetails.

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

    • toolUsePromptTokensDetails

      @CanIgnoreReturnValue public UsageMetadata.Builder toolUsePromptTokensDetails(ModalityTokenCount... toolUsePromptTokensDetails)
      Setter for toolUsePromptTokensDetails.

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

    • toolUsePromptTokensDetails

      @CanIgnoreReturnValue public UsageMetadata.Builder toolUsePromptTokensDetails(ModalityTokenCount.Builder... toolUsePromptTokensDetailsBuilders)
      Setter for toolUsePromptTokensDetails builder.

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

    • clearToolUsePromptTokensDetails

      @CanIgnoreReturnValue public UsageMetadata.Builder clearToolUsePromptTokensDetails()
      Clears the value of toolUsePromptTokensDetails field.

    • trafficType

      public 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 public UsageMetadata.Builder clearTrafficType()
      Clears the value of trafficType field.

    • trafficType

      @CanIgnoreReturnValue public 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 public 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

      public abstract UsageMetadata build()