com.google.cloud.discoveryengine.v1beta

Class RecommendResponse.RecommendationResult

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult

All Implemented Interfaces:

RecommendResponse.RecommendationResultOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

RecommendResponse

public static final class RecommendResponse.RecommendationResult
extends com.google.protobuf.GeneratedMessageV3
implements RecommendResponse.RecommendationResultOrBuilder

 RecommendationResult represents a generic recommendation result with
 associated metadata.
 

Protobuf type google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecommendResponse.RecommendationResult.Builder RecommendationResult represents a generic recommendation result with associated metadata.

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	DOCUMENT_FIELD_NUMBER
static int	ID_FIELD_NUMBER
static int	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	containsMetadata(String key) Additional Document metadata / annotations.
boolean	equals(Object obj)
static RecommendResponse.RecommendationResult	getDefaultInstance()
RecommendResponse.RecommendationResult	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Document	getDocument() Set if `returnDocument` is set to true in [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
DocumentOrBuilder	getDocumentOrBuilder() Set if `returnDocument` is set to true in [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
String	getId() Resource ID of the recommended Document.
com.google.protobuf.ByteString	getIdBytes() Resource ID of the recommended Document.
Map<String,com.google.protobuf.Value>	getMetadata() Deprecated.
int	getMetadataCount() Additional Document metadata / annotations.
Map<String,com.google.protobuf.Value>	getMetadataMap() Additional Document metadata / annotations.
com.google.protobuf.Value	getMetadataOrDefault(String key, com.google.protobuf.Value defaultValue) Additional Document metadata / annotations.
com.google.protobuf.Value	getMetadataOrThrow(String key) Additional Document metadata / annotations.
com.google.protobuf.Parser<RecommendResponse.RecommendationResult>	getParserForType()
int	getSerializedSize()
boolean	hasDocument() Set if `returnDocument` is set to true in [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static RecommendResponse.RecommendationResult.Builder	newBuilder()
static RecommendResponse.RecommendationResult.Builder	newBuilder(RecommendResponse.RecommendationResult prototype)
RecommendResponse.RecommendationResult.Builder	newBuilderForType()
protected RecommendResponse.RecommendationResult.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RecommendResponse.RecommendationResult	parseDelimitedFrom(InputStream input)
static RecommendResponse.RecommendationResult	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecommendResponse.RecommendationResult	parseFrom(byte[] data)
static RecommendResponse.RecommendationResult	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecommendResponse.RecommendationResult	parseFrom(ByteBuffer data)
static RecommendResponse.RecommendationResult	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecommendResponse.RecommendationResult	parseFrom(com.google.protobuf.ByteString data)
static RecommendResponse.RecommendationResult	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecommendResponse.RecommendationResult	parseFrom(com.google.protobuf.CodedInputStream input)
static RecommendResponse.RecommendationResult	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecommendResponse.RecommendationResult	parseFrom(InputStream input)
static RecommendResponse.RecommendationResult	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RecommendResponse.RecommendationResult>	parser()
RecommendResponse.RecommendationResult.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, 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

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

See Also:

Constant Field Values

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER

See Also:

Constant Field Values

METADATA_FIELD_NUMBER

public static final int 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()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getId

public String getId()

 Resource ID of the recommended Document.
 

string id = 1;

Specified by:

getId in interface RecommendResponse.RecommendationResultOrBuilder

Returns:

The id.

getIdBytes

public com.google.protobuf.ByteString getIdBytes()

 Resource ID of the recommended Document.
 

string id = 1;

Specified by:

getIdBytes in interface RecommendResponse.RecommendationResultOrBuilder

Returns:

The bytes for id.

hasDocument

public boolean hasDocument()

 Set if `returnDocument` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
 

.google.cloud.discoveryengine.v1beta.Document document = 2;

Specified by:

hasDocument in interface RecommendResponse.RecommendationResultOrBuilder

Returns:

Whether the document field is set.

getDocument

public Document getDocument()

 Set if `returnDocument` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
 

.google.cloud.discoveryengine.v1beta.Document document = 2;

Specified by:

getDocument in interface RecommendResponse.RecommendationResultOrBuilder

Returns:

The document.

getDocumentOrBuilder

public DocumentOrBuilder getDocumentOrBuilder()

 Set if `returnDocument` is set to true in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
 

.google.cloud.discoveryengine.v1beta.Document document = 2;

Specified by:

getDocumentOrBuilder in interface RecommendResponse.RecommendationResultOrBuilder

getMetadataCount

public int getMetadataCount()

Description copied from interface: RecommendResponse.RecommendationResultOrBuilder

 Additional Document metadata / annotations.

 Possible values:

 * `score`: Recommendation score in double value. Is set if
   `returnScore` is set to true in
   [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
 

map<string, .google.protobuf.Value> metadata = 3;

Specified by:

getMetadataCount in interface RecommendResponse.RecommendationResultOrBuilder

containsMetadata

public boolean containsMetadata(String key)

 Additional Document metadata / annotations.

 Possible values:

 * `score`: Recommendation score in double value. Is set if
   `returnScore` is set to true in
   [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
 

map<string, .google.protobuf.Value> metadata = 3;

Specified by:

containsMetadata in interface RecommendResponse.RecommendationResultOrBuilder

getMetadata

@Deprecated
public Map<String,com.google.protobuf.Value> getMetadata()

Deprecated.

Use getMetadataMap() instead.

Specified by:

getMetadata in interface RecommendResponse.RecommendationResultOrBuilder

getMetadataMap

public Map<String,com.google.protobuf.Value> getMetadataMap()

 Additional Document metadata / annotations.

 Possible values:

 * `score`: Recommendation score in double value. Is set if
   `returnScore` is set to true in
   [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
 

map<string, .google.protobuf.Value> metadata = 3;

Specified by:

getMetadataMap in interface RecommendResponse.RecommendationResultOrBuilder

getMetadataOrDefault

public com.google.protobuf.Value getMetadataOrDefault(String key,
                                                      com.google.protobuf.Value defaultValue)

 Additional Document metadata / annotations.

 Possible values:

 * `score`: Recommendation score in double value. Is set if
   `returnScore` is set to true in
   [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
 

map<string, .google.protobuf.Value> metadata = 3;

Specified by:

getMetadataOrDefault in interface RecommendResponse.RecommendationResultOrBuilder

getMetadataOrThrow

public com.google.protobuf.Value getMetadataOrThrow(String key)

 Additional Document metadata / annotations.

 Possible values:

 * `score`: Recommendation score in double value. Is set if
   `returnScore` is set to true in
   [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params].
 

map<string, .google.protobuf.Value> metadata = 3;

Specified by:

getMetadataOrThrow in interface RecommendResponse.RecommendationResultOrBuilder

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 RecommendResponse.RecommendationResult parseFrom(ByteBuffer data)
                                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RecommendResponse.RecommendationResult parseFrom(InputStream input)
                                                        throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static RecommendResponse.RecommendationResult parseDelimitedFrom(InputStream input)
                                                                 throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public RecommendResponse.RecommendationResult.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RecommendResponse.RecommendationResult.Builder newBuilder()

newBuilder

public static RecommendResponse.RecommendationResult.Builder newBuilder(RecommendResponse.RecommendationResult prototype)

toBuilder

public RecommendResponse.RecommendationResult.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RecommendResponse.RecommendationResult getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<RecommendResponse.RecommendationResult> 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 RecommendResponse.RecommendationResult getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder