Class GenerateContentResponse (3.77.0)
Version 3.77.0keyboard_arrow_down
public final class GenerateContentResponse extends GeneratedMessageV3 implements GenerateContentResponseOrBuilder
Response message for [PredictionService.GenerateContent].
Protobuf type google.cloud.aiplatform.v1.GenerateContentResponse
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CANDIDATES_FIELD_NUMBER
public static final int CANDIDATES_FIELD_NUMBER
Field Value
Type Description
int
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int
MODEL_VERSION_FIELD_NUMBER
public static final int MODEL_VERSION_FIELD_NUMBER
Field Value
Type Description
int
PROMPT_FEEDBACK_FIELD_NUMBER
public static final int PROMPT_FEEDBACK_FIELD_NUMBER
Field Value
Type Description
int
RESPONSE_ID_FIELD_NUMBER
public static final int RESPONSE_ID_FIELD_NUMBER
Field Value
Type Description
int
USAGE_METADATA_FIELD_NUMBER
public static final int USAGE_METADATA_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static GenerateContentResponse getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static GenerateContentResponse . Builder newBuilder ()
newBuilder(GenerateContentResponse prototype)
public static GenerateContentResponse . Builder newBuilder ( GenerateContentResponse prototype )
parseDelimitedFrom(InputStream input)
public static GenerateContentResponse parseDelimitedFrom ( InputStream input )
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GenerateContentResponse parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static GenerateContentResponse parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GenerateContentResponse parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static GenerateContentResponse parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GenerateContentResponse parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
parseFrom(CodedInputStream input)
public static GenerateContentResponse parseFrom ( CodedInputStream input )
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static GenerateContentResponse parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(InputStream input)
public static GenerateContentResponse parseFrom ( InputStream input )
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GenerateContentResponse parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static GenerateContentResponse parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GenerateContentResponse parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<GenerateContentResponse> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getCandidates(int index)
public Candidate getCandidates ( int index )
Output only. Generated candidates.
repeated .google.cloud.aiplatform.v1.Candidate candidates = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter
Name Description
indexint
getCandidatesCount()
public int getCandidatesCount ()
Output only. Generated candidates.
repeated .google.cloud.aiplatform.v1.Candidate candidates = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
int
getCandidatesList()
public List<Candidate> getCandidatesList ()
Output only. Generated candidates.
repeated .google.cloud.aiplatform.v1.Candidate candidates = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCandidatesOrBuilder(int index)
public CandidateOrBuilder getCandidatesOrBuilder ( int index )
Output only. Generated candidates.
repeated .google.cloud.aiplatform.v1.Candidate candidates = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter
Name Description
indexint
getCandidatesOrBuilderList()
public List <? extends CandidateOrBuilder > getCandidatesOrBuilderList ()
Output only. Generated candidates.
repeated .google.cloud.aiplatform.v1.Candidate candidates = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
List <? extends com.google.cloud.aiplatform.v1.CandidateOrBuilder >
getCreateTime()
public Timestamp getCreateTime ()
Output only. Timestamp when the request is made to the server.
.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
Timestamp The createTime.
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder ()
Output only. Timestamp when the request is made to the server.
.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public GenerateContentResponse getDefaultInstanceForType ()
getModelVersion()
public String getModelVersion ()
Output only. The model version used to generate the response.
string model_version = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
String The modelVersion.
getModelVersionBytes()
public ByteString getModelVersionBytes ()
Output only. The model version used to generate the response.
string model_version = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
ByteString The bytes for modelVersion.
getParserForType()
public Parser<GenerateContentResponse> getParserForType ()
Overrides
getPromptFeedback()
public GenerateContentResponse . PromptFeedback getPromptFeedback ()
Output only. Content filter results for a prompt sent in the request.
Note: Sent only in the first stream chunk.
Only happens when no candidates were generated due to content violations.
.google.cloud.aiplatform.v1.GenerateContentResponse.PromptFeedback prompt_feedback = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getPromptFeedbackOrBuilder()
public GenerateContentResponse . PromptFeedbackOrBuilder getPromptFeedbackOrBuilder ()
Output only. Content filter results for a prompt sent in the request.
Note: Sent only in the first stream chunk.
Only happens when no candidates were generated due to content violations.
.google.cloud.aiplatform.v1.GenerateContentResponse.PromptFeedback prompt_feedback = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getResponseId()
public String getResponseId ()
Output only. response_id is used to identify each response. It is the
encoding of the event_id.
string response_id = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
String The responseId.
getResponseIdBytes()
public ByteString getResponseIdBytes ()
Output only. response_id is used to identify each response. It is the
encoding of the event_id.
string response_id = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
ByteString The bytes for responseId.
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getUsageMetadata()
public GenerateContentResponse . UsageMetadata getUsageMetadata ()
Usage metadata about the response(s).
.google.cloud.aiplatform.v1.GenerateContentResponse.UsageMetadata usage_metadata = 4;
getUsageMetadataOrBuilder()
public GenerateContentResponse . UsageMetadataOrBuilder getUsageMetadataOrBuilder ()
Usage metadata about the response(s).
.google.cloud.aiplatform.v1.GenerateContentResponse.UsageMetadata usage_metadata = 4;
hasCreateTime()
public boolean hasCreateTime ()
Output only. Timestamp when the request is made to the server.
.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
boolean Whether the createTime field is set.
hasPromptFeedback()
public boolean hasPromptFeedback ()
Output only. Content filter results for a prompt sent in the request.
Note: Sent only in the first stream chunk.
Only happens when no candidates were generated due to content violations.
.google.cloud.aiplatform.v1.GenerateContentResponse.PromptFeedback prompt_feedback = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type Description
boolean Whether the promptFeedback field is set.
hasUsageMetadata()
public boolean hasUsageMetadata ()
Usage metadata about the response(s).
.google.cloud.aiplatform.v1.GenerateContentResponse.UsageMetadata usage_metadata = 4;
Returns
Type Description
boolean Whether the usageMetadata field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public GenerateContentResponse . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected GenerateContentResponse . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public GenerateContentResponse . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
