Package com.google.genai.types

Class GenerateContentResponseUsageMetadata.Builder

java.lang.Object

com.google.genai.types.GenerateContentResponseUsageMetadata.Builder

Enclosing class:

GenerateContentResponseUsageMetadata

public abstract static class GenerateContentResponseUsageMetadata.Builder
extends Object

Builder for GenerateContentResponseUsageMetadata.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
abstract GenerateContentResponseUsageMetadata	build()
abstract GenerateContentResponseUsageMetadata.Builder	cachedContentTokenCount(Integer cachedContentTokenCount)	Setter for cachedContentTokenCount.
GenerateContentResponseUsageMetadata.Builder	cacheTokensDetails(ModalityTokenCount... cacheTokensDetails)	Setter for cacheTokensDetails.
GenerateContentResponseUsageMetadata.Builder	cacheTokensDetails(ModalityTokenCount.Builder... cacheTokensDetailsBuilders)	Setter for cacheTokensDetails builder.
abstract GenerateContentResponseUsageMetadata.Builder	cacheTokensDetails(List<ModalityTokenCount> cacheTokensDetails)	Setter for cacheTokensDetails.
abstract GenerateContentResponseUsageMetadata.Builder	candidatesTokenCount(Integer candidatesTokenCount)	Setter for candidatesTokenCount.
GenerateContentResponseUsageMetadata.Builder	candidatesTokensDetails(ModalityTokenCount... candidatesTokensDetails)	Setter for candidatesTokensDetails.
GenerateContentResponseUsageMetadata.Builder	candidatesTokensDetails(ModalityTokenCount.Builder... candidatesTokensDetailsBuilders)	Setter for candidatesTokensDetails builder.
abstract GenerateContentResponseUsageMetadata.Builder	candidatesTokensDetails(List<ModalityTokenCount> candidatesTokensDetails)	Setter for candidatesTokensDetails.
abstract GenerateContentResponseUsageMetadata.Builder	promptTokenCount(Integer promptTokenCount)	Setter for promptTokenCount.
GenerateContentResponseUsageMetadata.Builder	promptTokensDetails(ModalityTokenCount... promptTokensDetails)	Setter for promptTokensDetails.
GenerateContentResponseUsageMetadata.Builder	promptTokensDetails(ModalityTokenCount.Builder... promptTokensDetailsBuilders)	Setter for promptTokensDetails builder.
abstract GenerateContentResponseUsageMetadata.Builder	promptTokensDetails(List<ModalityTokenCount> promptTokensDetails)	Setter for promptTokensDetails.
abstract GenerateContentResponseUsageMetadata.Builder	thoughtsTokenCount(Integer thoughtsTokenCount)	Setter for thoughtsTokenCount.
abstract GenerateContentResponseUsageMetadata.Builder	toolUsePromptTokenCount(Integer toolUsePromptTokenCount)	Setter for toolUsePromptTokenCount.
GenerateContentResponseUsageMetadata.Builder	toolUsePromptTokensDetails(ModalityTokenCount... toolUsePromptTokensDetails)	Setter for toolUsePromptTokensDetails.
GenerateContentResponseUsageMetadata.Builder	toolUsePromptTokensDetails(ModalityTokenCount.Builder... toolUsePromptTokensDetailsBuilders)	Setter for toolUsePromptTokensDetails builder.
abstract GenerateContentResponseUsageMetadata.Builder	toolUsePromptTokensDetails(List<ModalityTokenCount> toolUsePromptTokensDetails)	Setter for toolUsePromptTokensDetails.
abstract GenerateContentResponseUsageMetadata.Builder	totalTokenCount(Integer totalTokenCount)	Setter for totalTokenCount.
abstract GenerateContentResponseUsageMetadata.Builder	trafficType(TrafficType trafficType)	Setter for trafficType.
GenerateContentResponseUsageMetadata.Builder	trafficType(TrafficType.Known knownType)	Setter for trafficType given a known enum.
GenerateContentResponseUsageMetadata.Builder	trafficType(String trafficType)	Setter for trafficType given a string.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

cacheTokensDetails

public abstract GenerateContentResponseUsageMetadata.Builder cacheTokensDetails(List<ModalityTokenCount> cacheTokensDetails)

Setter for cacheTokensDetails.

cacheTokensDetails: Output only. List of modalities of the cached content in the request input.

cacheTokensDetails

public GenerateContentResponseUsageMetadata.Builder cacheTokensDetails(ModalityTokenCount... cacheTokensDetails)

Setter for cacheTokensDetails.

cacheTokensDetails: Output only. List of modalities of the cached content in the request input.

cacheTokensDetails

public GenerateContentResponseUsageMetadata.Builder cacheTokensDetails(ModalityTokenCount.Builder... cacheTokensDetailsBuilders)

Setter for cacheTokensDetails builder.

cacheTokensDetails: Output only. List of modalities of the cached content in the request input.

cachedContentTokenCount

public abstract GenerateContentResponseUsageMetadata.Builder cachedContentTokenCount(Integer cachedContentTokenCount)

Setter for cachedContentTokenCount.

cachedContentTokenCount: Output only. Number of tokens in the cached part in the input (the cached content).

candidatesTokenCount

public abstract GenerateContentResponseUsageMetadata.Builder candidatesTokenCount(Integer candidatesTokenCount)

Setter for candidatesTokenCount.

candidatesTokenCount: Number of tokens in the response(s).

candidatesTokensDetails

public abstract GenerateContentResponseUsageMetadata.Builder candidatesTokensDetails(List<ModalityTokenCount> candidatesTokensDetails)

Setter for candidatesTokensDetails.

candidatesTokensDetails: Output only. List of modalities that were returned in the response.

candidatesTokensDetails

public GenerateContentResponseUsageMetadata.Builder candidatesTokensDetails(ModalityTokenCount... candidatesTokensDetails)

Setter for candidatesTokensDetails.

candidatesTokensDetails: Output only. List of modalities that were returned in the response.

candidatesTokensDetails

public GenerateContentResponseUsageMetadata.Builder candidatesTokensDetails(ModalityTokenCount.Builder... candidatesTokensDetailsBuilders)

Setter for candidatesTokensDetails builder.

candidatesTokensDetails: Output only. List of modalities that were returned in the response.

promptTokenCount

public abstract GenerateContentResponseUsageMetadata.Builder promptTokenCount(Integer promptTokenCount)

Setter for promptTokenCount.

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

promptTokensDetails

public abstract GenerateContentResponseUsageMetadata.Builder promptTokensDetails(List<ModalityTokenCount> promptTokensDetails)

Setter for promptTokensDetails.

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

promptTokensDetails

public GenerateContentResponseUsageMetadata.Builder promptTokensDetails(ModalityTokenCount... promptTokensDetails)

Setter for promptTokensDetails.

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

promptTokensDetails

public GenerateContentResponseUsageMetadata.Builder promptTokensDetails(ModalityTokenCount.Builder... promptTokensDetailsBuilders)

Setter for promptTokensDetails builder.

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

thoughtsTokenCount

public abstract GenerateContentResponseUsageMetadata.Builder thoughtsTokenCount(Integer thoughtsTokenCount)

Setter for thoughtsTokenCount.

thoughtsTokenCount: Output only. Number of tokens present in thoughts output.

toolUsePromptTokenCount

public abstract GenerateContentResponseUsageMetadata.Builder toolUsePromptTokenCount(Integer toolUsePromptTokenCount)

Setter for toolUsePromptTokenCount.

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

toolUsePromptTokensDetails

public abstract GenerateContentResponseUsageMetadata.Builder toolUsePromptTokensDetails(List<ModalityTokenCount> toolUsePromptTokensDetails)

Setter for toolUsePromptTokensDetails.

toolUsePromptTokensDetails: Output only. List of modalities that were processed for tool-use request inputs.

toolUsePromptTokensDetails

public GenerateContentResponseUsageMetadata.Builder toolUsePromptTokensDetails(ModalityTokenCount... toolUsePromptTokensDetails)

Setter for toolUsePromptTokensDetails.

toolUsePromptTokensDetails: Output only. List of modalities that were processed for tool-use request inputs.

toolUsePromptTokensDetails

public GenerateContentResponseUsageMetadata.Builder toolUsePromptTokensDetails(ModalityTokenCount.Builder... toolUsePromptTokensDetailsBuilders)

Setter for toolUsePromptTokensDetails builder.

toolUsePromptTokensDetails: Output only. List of modalities that were processed for tool-use request inputs.

totalTokenCount

public abstract GenerateContentResponseUsageMetadata.Builder totalTokenCount(Integer totalTokenCount)

Setter for totalTokenCount.

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

trafficType

public abstract GenerateContentResponseUsageMetadata.Builder trafficType(TrafficType trafficType)

Setter for trafficType.

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

trafficType

@CanIgnoreReturnValue
public GenerateContentResponseUsageMetadata.Builder trafficType(TrafficType.Known knownType)

Setter for trafficType given a known enum.

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

trafficType

@CanIgnoreReturnValue
public GenerateContentResponseUsageMetadata.Builder trafficType(String trafficType)

Setter for trafficType given a string.

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

build

public abstract GenerateContentResponseUsageMetadata build()