com.google.cloud.aiplatform.v1

Class GenerateContentResponse

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1.GenerateContentResponse

All Implemented Interfaces:

GenerateContentResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class GenerateContentResponse
extends com.google.protobuf.GeneratedMessageV3
implements GenerateContentResponseOrBuilder

 Response message for [PredictionService.GenerateContent].
 

Protobuf type google.cloud.aiplatform.v1.GenerateContentResponse

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenerateContentResponse.Builder Response message for [PredictionService.GenerateContent].
static class	GenerateContentResponse.PromptFeedback Content filter results for a prompt sent in the request.
static interface	GenerateContentResponse.PromptFeedbackOrBuilder
static class	GenerateContentResponse.UsageMetadata Usage metadata about response(s).
static interface	GenerateContentResponse.UsageMetadataOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CANDIDATES_FIELD_NUMBER
static int	PROMPT_FEEDBACK_FIELD_NUMBER
static int	USAGE_METADATA_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Candidate	getCandidates(int index) Output only.
int	getCandidatesCount() Output only.
List<Candidate>	getCandidatesList() Output only.
CandidateOrBuilder	getCandidatesOrBuilder(int index) Output only.
List<? extends CandidateOrBuilder>	getCandidatesOrBuilderList() Output only.
static GenerateContentResponse	getDefaultInstance()
GenerateContentResponse	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<GenerateContentResponse>	getParserForType()
GenerateContentResponse.PromptFeedback	getPromptFeedback() Output only.
GenerateContentResponse.PromptFeedbackOrBuilder	getPromptFeedbackOrBuilder() Output only.
int	getSerializedSize()
GenerateContentResponse.UsageMetadata	getUsageMetadata() Usage metadata about the response(s).
GenerateContentResponse.UsageMetadataOrBuilder	getUsageMetadataOrBuilder() Usage metadata about the response(s).
int	hashCode()
boolean	hasPromptFeedback() Output only.
boolean	hasUsageMetadata() Usage metadata about the response(s).
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static GenerateContentResponse.Builder	newBuilder()
static GenerateContentResponse.Builder	newBuilder(GenerateContentResponse prototype)
GenerateContentResponse.Builder	newBuilderForType()
protected GenerateContentResponse.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static GenerateContentResponse	parseDelimitedFrom(InputStream input)
static GenerateContentResponse	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateContentResponse	parseFrom(byte[] data)
static GenerateContentResponse	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateContentResponse	parseFrom(ByteBuffer data)
static GenerateContentResponse	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateContentResponse	parseFrom(com.google.protobuf.ByteString data)
static GenerateContentResponse	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateContentResponse	parseFrom(com.google.protobuf.CodedInputStream input)
static GenerateContentResponse	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateContentResponse	parseFrom(InputStream input)
static GenerateContentResponse	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<GenerateContentResponse>	parser()
GenerateContentResponse.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

CANDIDATES_FIELD_NUMBER

public static final int CANDIDATES_FIELD_NUMBER

See Also:

Constant Field Values

PROMPT_FEEDBACK_FIELD_NUMBER

public static final int PROMPT_FEEDBACK_FIELD_NUMBER

See Also:

Constant Field Values

USAGE_METADATA_FIELD_NUMBER

public static final int USAGE_METADATA_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getCandidatesList

public List<Candidate> getCandidatesList()

 Output only. Generated candidates.
 

repeated .google.cloud.aiplatform.v1.Candidate candidates = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getCandidatesList in interface GenerateContentResponseOrBuilder

getCandidatesOrBuilderList

public List<? extends CandidateOrBuilder> getCandidatesOrBuilderList()

 Output only. Generated candidates.
 

repeated .google.cloud.aiplatform.v1.Candidate candidates = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getCandidatesOrBuilderList in interface GenerateContentResponseOrBuilder

getCandidatesCount

public int getCandidatesCount()

 Output only. Generated candidates.
 

repeated .google.cloud.aiplatform.v1.Candidate candidates = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getCandidatesCount in interface GenerateContentResponseOrBuilder

getCandidates

public Candidate getCandidates(int index)

 Output only. Generated candidates.
 

repeated .google.cloud.aiplatform.v1.Candidate candidates = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getCandidates in interface GenerateContentResponseOrBuilder

getCandidatesOrBuilder

public CandidateOrBuilder getCandidatesOrBuilder(int index)

 Output only. Generated candidates.
 

repeated .google.cloud.aiplatform.v1.Candidate candidates = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getCandidatesOrBuilder in interface GenerateContentResponseOrBuilder

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];

Specified by:

hasPromptFeedback in interface GenerateContentResponseOrBuilder

Returns:

Whether the promptFeedback field is set.

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];

Specified by:

getPromptFeedback in interface GenerateContentResponseOrBuilder

Returns:

The promptFeedback.

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];

Specified by:

getPromptFeedbackOrBuilder in interface GenerateContentResponseOrBuilder

hasUsageMetadata

public boolean hasUsageMetadata()

 Usage metadata about the response(s).
 

.google.cloud.aiplatform.v1.GenerateContentResponse.UsageMetadata usage_metadata = 4;

Specified by:

hasUsageMetadata in interface GenerateContentResponseOrBuilder

Returns:

Whether the usageMetadata field is set.

getUsageMetadata

public GenerateContentResponse.UsageMetadata getUsageMetadata()

 Usage metadata about the response(s).
 

.google.cloud.aiplatform.v1.GenerateContentResponse.UsageMetadata usage_metadata = 4;

Specified by:

getUsageMetadata in interface GenerateContentResponseOrBuilder

Returns:

The usageMetadata.

getUsageMetadataOrBuilder

public GenerateContentResponse.UsageMetadataOrBuilder getUsageMetadataOrBuilder()

 Usage metadata about the response(s).
 

.google.cloud.aiplatform.v1.GenerateContentResponse.UsageMetadata usage_metadata = 4;

Specified by:

getUsageMetadataOrBuilder in interface GenerateContentResponseOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static GenerateContentResponse parseFrom(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateContentResponse parseFrom(ByteBuffer data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateContentResponse parseFrom(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateContentResponse parseFrom(com.google.protobuf.ByteString data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateContentResponse parseFrom(byte[] data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateContentResponse parseFrom(byte[] data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateContentResponse parseFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static GenerateContentResponse parseFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static GenerateContentResponse parseDelimitedFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static GenerateContentResponse parseDelimitedFrom(InputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

parseFrom

public static GenerateContentResponse parseFrom(com.google.protobuf.CodedInputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static GenerateContentResponse parseFrom(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

newBuilderForType

public GenerateContentResponse.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static GenerateContentResponse.Builder newBuilder()

newBuilder

public static GenerateContentResponse.Builder newBuilder(GenerateContentResponse prototype)

toBuilder

public GenerateContentResponse.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected GenerateContentResponse.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static GenerateContentResponse getDefaultInstance()

parser

public static com.google.protobuf.Parser<GenerateContentResponse> parser()

getParserForType

public com.google.protobuf.Parser<GenerateContentResponse> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public GenerateContentResponse getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder