Class GenerateContentResponse.UsageMetadata (0.8.0)

public static final class GenerateContentResponse.UsageMetadata extends GeneratedMessageV3 implements GenerateContentResponse.UsageMetadataOrBuilder

Usage metadata about response(s).

Protobuf type google.cloud.vertexai.v1.GenerateContentResponse.UsageMetadata

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > GenerateContentResponse.UsageMetadata

Static Fields

CANDIDATES_TOKEN_COUNT_FIELD_NUMBER

public static final int CANDIDATES_TOKEN_COUNT_FIELD_NUMBER
Field Value
Type Description
int

PROMPT_TOKEN_COUNT_FIELD_NUMBER

public static final int PROMPT_TOKEN_COUNT_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_TOKEN_COUNT_FIELD_NUMBER

public static final int TOTAL_TOKEN_COUNT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GenerateContentResponse.UsageMetadata getDefaultInstance()
Returns
Type Description
GenerateContentResponse.UsageMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static GenerateContentResponse.UsageMetadata.Builder newBuilder()
Returns
Type Description
GenerateContentResponse.UsageMetadata.Builder

newBuilder(GenerateContentResponse.UsageMetadata prototype)

public static GenerateContentResponse.UsageMetadata.Builder newBuilder(GenerateContentResponse.UsageMetadata prototype)
Parameter
Name Description
prototype GenerateContentResponse.UsageMetadata
Returns
Type Description
GenerateContentResponse.UsageMetadata.Builder

parseDelimitedFrom(InputStream input)

public static GenerateContentResponse.UsageMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GenerateContentResponse.UsageMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerateContentResponse.UsageMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateContentResponse.UsageMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static GenerateContentResponse.UsageMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
GenerateContentResponse.UsageMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GenerateContentResponse.UsageMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateContentResponse.UsageMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GenerateContentResponse.UsageMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GenerateContentResponse.UsageMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GenerateContentResponse.UsageMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateContentResponse.UsageMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GenerateContentResponse.UsageMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GenerateContentResponse.UsageMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerateContentResponse.UsageMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateContentResponse.UsageMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static GenerateContentResponse.UsageMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GenerateContentResponse.UsageMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerateContentResponse.UsageMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateContentResponse.UsageMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static GenerateContentResponse.UsageMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GenerateContentResponse.UsageMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GenerateContentResponse.UsageMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GenerateContentResponse.UsageMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<GenerateContentResponse.UsageMetadata> parser()
Returns
Type Description
Parser<UsageMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCandidatesTokenCount()

public int getCandidatesTokenCount()

Number of tokens in the response(s).

int32 candidates_token_count = 2;

Returns
Type Description
int

The candidatesTokenCount.

getDefaultInstanceForType()

public GenerateContentResponse.UsageMetadata getDefaultInstanceForType()
Returns
Type Description
GenerateContentResponse.UsageMetadata

getParserForType()

public Parser<GenerateContentResponse.UsageMetadata> getParserForType()
Returns
Type Description
Parser<UsageMetadata>
Overrides

getPromptTokenCount()

public int getPromptTokenCount()

Number of tokens in the request.

int32 prompt_token_count = 1;

Returns
Type Description
int

The promptTokenCount.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTotalTokenCount()

public int getTotalTokenCount()

int32 total_token_count = 3;

Returns
Type Description
int

The totalTokenCount.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public GenerateContentResponse.UsageMetadata.Builder newBuilderForType()
Returns
Type Description
GenerateContentResponse.UsageMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GenerateContentResponse.UsageMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GenerateContentResponse.UsageMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public GenerateContentResponse.UsageMetadata.Builder toBuilder()
Returns
Type Description
GenerateContentResponse.UsageMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException