google-genai/com.google.genai.types/GenerateContentResponseUsageMetadata

GenerateContentResponseUsageMetadata

public abstract class GenerateContentResponseUsageMetadata extends JsonSerializable

Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. This data type is not supported in Gemini API.

Constructors

Link copied to clipboard

Types

Link copied to clipboard
public abstract class Builder
Builder for GenerateContentResponseUsageMetadata.

Properties

Link copied to clipboard
public final static String MAX_READ_LENGTH_PROPERTY
System property to override the default max JSON string length (20MB) in read constraints.

Functions

Link copied to clipboard
public static GenerateContentResponseUsageMetadata.Builder builder()
Instantiates a builder for GenerateContentResponseUsageMetadata.
Link copied to clipboard
public abstract Optional<Integer> cachedContentTokenCount()
Output only.
Link copied to clipboard
public abstract Optional<List<ModalityTokenCount>> cacheTokensDetails()
Output only.
Link copied to clipboard
public abstract Optional<Integer> candidatesTokenCount()
The total number of tokens in the generated candidates.
Link copied to clipboard
public abstract Optional<List<ModalityTokenCount>> candidatesTokensDetails()
Output only.
Link copied to clipboard
public static GenerateContentResponseUsageMetadata fromJson(String jsonString)
Deserializes a JSON string to a GenerateContentResponseUsageMetadata object.
Link copied to clipboard
@InternalApi()
public static T fromJsonNode<T extends JsonSerializable>(JsonNode jsonNode, Class<T> clazz)
Deserializes a JsonNode to an object of the given type.
Link copied to clipboard
@InternalApi()
public static T fromJsonString<T extends JsonSerializable>(String jsonString, Class<T> clazz)
Deserializes a Json string to an object of the given type.
Link copied to clipboard
public static ObjectMapper objectMapper()
Link copied to clipboard
public abstract Optional<Integer> promptTokenCount()
The total number of tokens in the prompt.
Link copied to clipboard
public abstract Optional<List<ModalityTokenCount>> promptTokensDetails()
Output only.
Link copied to clipboard
public static void setMaxReadLength(int maxReadLength)
Overrides the default maximum JSON string length (20MB) for the JSON parser.
Link copied to clipboard
public static JsonNode stringToJsonNode(String string)
Converts a Json string to a JsonNode.
Link copied to clipboard
public abstract Optional<Integer> thoughtsTokenCount()
Output only.
Link copied to clipboard
public abstract GenerateContentResponseUsageMetadata.Builder toBuilder()
Creates a builder with the same values as this instance.
Link copied to clipboard
public String toJson()
Serializes the instance to a Json string.
Link copied to clipboard
public static JsonNode toJsonNode(Object object)
Serializes an object to a JsonNode.
Link copied to clipboard
public static String toJsonString(Object object)
Serializes an object to a Json string.
Link copied to clipboard
public abstract Optional<Integer> toolUsePromptTokenCount()
Output only.
Link copied to clipboard
public abstract Optional<List<ModalityTokenCount>> toolUsePromptTokensDetails()
Output only.
Link copied to clipboard
public abstract Optional<Integer> totalTokenCount()
The total number of tokens for the entire request.
Link copied to clipboard
public abstract Optional<TrafficType> trafficType()
Output only.