All Implemented Interfaces:
```
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.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public abstract class`	`GenerateContentResponseUsageMetadata.Builder`	Builder for GenerateContentResponseUsageMetadata.

Field Summary

Fields
Modifier and Type	Field	Description
`public final static String`	`MAX_READ_LENGTH_PROPERTY`

Constructor Summary

Constructors
Constructor	Description
`GenerateContentResponseUsageMetadata()`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract Optional<List<ModalityTokenCount>>`	`cacheTokensDetails()`	Output only.
`abstract Optional<Integer>`	`cachedContentTokenCount()`	Output only.
`abstract Optional<Integer>`	`candidatesTokenCount()`	The total number of tokens in the generated candidates.
`abstract Optional<List<ModalityTokenCount>>`	`candidatesTokensDetails()`	Output only.
`abstract Optional<Integer>`	`promptTokenCount()`	The total number of tokens in the prompt.
`abstract Optional<List<ModalityTokenCount>>`	`promptTokensDetails()`	Output only.
`abstract Optional<Integer>`	`thoughtsTokenCount()`	Output only.
`abstract Optional<Integer>`	`toolUsePromptTokenCount()`	Output only.
`abstract Optional<List<ModalityTokenCount>>`	`toolUsePromptTokensDetails()`	Output only.
`abstract Optional<Integer>`	`totalTokenCount()`	The total number of tokens for the entire request.
`abstract Optional<TrafficType>`	`trafficType()`	Output only.
`static GenerateContentResponseUsageMetadata.Builder`	`builder()`	Instantiates a builder for GenerateContentResponseUsageMetadata.
`abstract GenerateContentResponseUsageMetadata.Builder`	`toBuilder()`	Creates a builder with the same values as this instance.
`static GenerateContentResponseUsageMetadata`	`fromJson(String jsonString)`	Deserializes a JSON string to a GenerateContentResponseUsageMetadata object.

Methods inherited from class com.google.genai.JsonSerializable
fromJsonNode, fromJsonString, objectMapper, setMaxReadLength, stringToJsonNode, toJson, toJsonNode, toJsonString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GenerateContentResponseUsageMetadata
```
GenerateContentResponseUsageMetadata()
```
- Method Detail
  - cacheTokensDetails
```
 abstract Optional<List<ModalityTokenCount>> cacheTokensDetails()
```
    Output only. A detailed breakdown of the token count for each modality in the cached content.
  - cachedContentTokenCount
```
 abstract Optional<Integer> cachedContentTokenCount()
```
    Output only. The number of tokens in the cached content that was used for this request.
  - candidatesTokenCount
```
 abstract Optional<Integer> candidatesTokenCount()
```
    The total number of tokens in the generated candidates.
  - candidatesTokensDetails
```
 abstract Optional<List<ModalityTokenCount>> candidatesTokensDetails()
```
    Output only. A detailed breakdown of the token count for each modality in the generated candidates.
  - promptTokenCount
```
 abstract Optional<Integer> promptTokenCount()
```
    The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.
  - promptTokensDetails
```
 abstract Optional<List<ModalityTokenCount>> promptTokensDetails()
```
    Output only. A detailed breakdown of the token count for each modality in the prompt.
  - thoughtsTokenCount
```
 abstract Optional<Integer> thoughtsTokenCount()
```
    Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable.
  - toolUsePromptTokenCount
```
 abstract Optional<Integer> toolUsePromptTokenCount()
```
    Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.
  - toolUsePromptTokensDetails
```
 abstract Optional<List<ModalityTokenCount>> toolUsePromptTokensDetails()
```
    Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
  - totalTokenCount
```
 abstract Optional<Integer> totalTokenCount()
```
    The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.
  - trafficType
```
 abstract Optional<TrafficType> trafficType()
```
    Output only. The traffic type for this request.
  - builder
```
 static GenerateContentResponseUsageMetadata.Builder builder()
```
    Instantiates a builder for GenerateContentResponseUsageMetadata.
  - toBuilder
```
 abstract GenerateContentResponseUsageMetadata.Builder toBuilder()
```
    Creates a builder with the same values as this instance.
  - fromJson
```
 static GenerateContentResponseUsageMetadata fromJson(String jsonString)
```
    Deserializes a JSON string to a GenerateContentResponseUsageMetadata object.

Class GenerateContentResponseUsageMetadata

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class com.google.genai.JsonSerializable

Methods inherited from class java.lang.Object

Constructor Detail

GenerateContentResponseUsageMetadata

Method Detail

cacheTokensDetails

cachedContentTokenCount

candidatesTokenCount

candidatesTokensDetails

promptTokenCount

promptTokensDetails

thoughtsTokenCount

toolUsePromptTokenCount

toolUsePromptTokensDetails

totalTokenCount

trafficType

builder

toBuilder

fromJson