google-genai/com.google.genai.types/UsageMetadata

UsageMetadata

public abstract class UsageMetadata extends JsonSerializable

Usage metadata about response(s).

Constructors

Link copied to clipboard
public void UsageMetadata()

Types

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

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 UsageMetadata.Builder builder()
Instantiates a builder for UsageMetadata.
Link copied to clipboard
public abstract Optional<Integer> cachedContentTokenCount()
Number of tokens in the cached part of the prompt (the cached content).
Link copied to clipboard
public abstract Optional<List<ModalityTokenCount>> cacheTokensDetails()
List of modalities that were processed in the cache input.
Link copied to clipboard
public static UsageMetadata fromJson(String jsonString)
Deserializes a JSON string to a UsageMetadata 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()
Number of tokens in the prompt.
Link copied to clipboard
public abstract Optional<List<ModalityTokenCount>> promptTokensDetails()
List of modalities that were processed in the request input.
Link copied to clipboard
public abstract Optional<Integer> responseTokenCount()
Total number of tokens across all the generated response candidates.
Link copied to clipboard
public abstract Optional<List<ModalityTokenCount>> responseTokensDetails()
List of modalities that were returned in the response.
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()
Number of tokens of thoughts for thinking models.
Link copied to clipboard
public abstract UsageMetadata.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()
Number of tokens present in tool-use prompt(s).
Link copied to clipboard
public abstract Optional<List<ModalityTokenCount>> toolUsePromptTokensDetails()
List of modalities that were processed in the tool-use prompt.
Link copied to clipboard
public abstract Optional<Integer> totalTokenCount()
Total token count for prompt, response candidates, and tool-use prompts(if present).
Link copied to clipboard
public abstract Optional<TrafficType> trafficType()
Traffic type.