com.google.cloud.discoveryengine.v1alpha

Class RecommendResponse

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1alpha.RecommendResponse

All Implemented Interfaces:

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

public final class RecommendResponse
extends com.google.protobuf.GeneratedMessageV3
implements RecommendResponseOrBuilder

 Response message for Recommend method.
 

Protobuf type google.cloud.discoveryengine.v1alpha.RecommendResponse

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecommendResponse.Builder Response message for Recommend method.
static class	RecommendResponse.RecommendationResult RecommendationResult represents a generic recommendation result with associated metadata.
static interface	RecommendResponse.RecommendationResultOrBuilder

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	ATTRIBUTION_TOKEN_FIELD_NUMBER
static int	MISSING_IDS_FIELD_NUMBER
static int	RESULTS_FIELD_NUMBER
static int	VALIDATE_ONLY_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)
String	getAttributionToken() A unique attribution token.
com.google.protobuf.ByteString	getAttributionTokenBytes() A unique attribution token.
static RecommendResponse	getDefaultInstance()
RecommendResponse	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getMissingIds(int index) IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.
com.google.protobuf.ByteString	getMissingIdsBytes(int index) IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.
int	getMissingIdsCount() IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.
com.google.protobuf.ProtocolStringList	getMissingIdsList() IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.
com.google.protobuf.Parser<RecommendResponse>	getParserForType()
RecommendResponse.RecommendationResult	getResults(int index) A list of recommended Documents.
int	getResultsCount() A list of recommended Documents.
List<RecommendResponse.RecommendationResult>	getResultsList() A list of recommended Documents.
RecommendResponse.RecommendationResultOrBuilder	getResultsOrBuilder(int index) A list of recommended Documents.
List<? extends RecommendResponse.RecommendationResultOrBuilder>	getResultsOrBuilderList() A list of recommended Documents.
int	getSerializedSize()
boolean	getValidateOnly() True if [RecommendRequest.validate_only][google.cloud.discoveryengine.v1alpha.RecommendRequest.validate_only] was set.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RecommendResponse.Builder	newBuilder()
static RecommendResponse.Builder	newBuilder(RecommendResponse prototype)
RecommendResponse.Builder	newBuilderForType()
protected RecommendResponse.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RecommendResponse	parseDelimitedFrom(InputStream input)
static RecommendResponse	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecommendResponse	parseFrom(byte[] data)
static RecommendResponse	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecommendResponse	parseFrom(ByteBuffer data)
static RecommendResponse	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecommendResponse	parseFrom(com.google.protobuf.ByteString data)
static RecommendResponse	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecommendResponse	parseFrom(com.google.protobuf.CodedInputStream input)
static RecommendResponse	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RecommendResponse	parseFrom(InputStream input)
static RecommendResponse	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RecommendResponse>	parser()
RecommendResponse.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

RESULTS_FIELD_NUMBER

public static final int RESULTS_FIELD_NUMBER

See Also:

Constant Field Values

ATTRIBUTION_TOKEN_FIELD_NUMBER

public static final int ATTRIBUTION_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

MISSING_IDS_FIELD_NUMBER

public static final int MISSING_IDS_FIELD_NUMBER

See Also:

Constant Field Values

VALIDATE_ONLY_FIELD_NUMBER

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

getResultsList

public List<RecommendResponse.RecommendationResult> getResultsList()

 A list of recommended Documents. The order represents the ranking (from the
 most relevant Document to the least).
 

repeated .google.cloud.discoveryengine.v1alpha.RecommendResponse.RecommendationResult results = 1;

Specified by:

getResultsList in interface RecommendResponseOrBuilder

getResultsOrBuilderList

public List<? extends RecommendResponse.RecommendationResultOrBuilder> getResultsOrBuilderList()

 A list of recommended Documents. The order represents the ranking (from the
 most relevant Document to the least).
 

repeated .google.cloud.discoveryengine.v1alpha.RecommendResponse.RecommendationResult results = 1;

Specified by:

getResultsOrBuilderList in interface RecommendResponseOrBuilder

getResultsCount

public int getResultsCount()

 A list of recommended Documents. The order represents the ranking (from the
 most relevant Document to the least).
 

repeated .google.cloud.discoveryengine.v1alpha.RecommendResponse.RecommendationResult results = 1;

Specified by:

getResultsCount in interface RecommendResponseOrBuilder

getResults

public RecommendResponse.RecommendationResult getResults(int index)

 A list of recommended Documents. The order represents the ranking (from the
 most relevant Document to the least).
 

repeated .google.cloud.discoveryengine.v1alpha.RecommendResponse.RecommendationResult results = 1;

Specified by:

getResults in interface RecommendResponseOrBuilder

getResultsOrBuilder

public RecommendResponse.RecommendationResultOrBuilder getResultsOrBuilder(int index)

 A list of recommended Documents. The order represents the ranking (from the
 most relevant Document to the least).
 

repeated .google.cloud.discoveryengine.v1alpha.RecommendResponse.RecommendationResult results = 1;

Specified by:

getResultsOrBuilder in interface RecommendResponseOrBuilder

getAttributionToken

public String getAttributionToken()

 A unique attribution token. This should be included in the
 [UserEvent][google.cloud.discoveryengine.v1alpha.UserEvent] logs resulting
 from this recommendation, which enables accurate attribution of
 recommendation model performance.
 

string attribution_token = 2;

Specified by:

getAttributionToken in interface RecommendResponseOrBuilder

Returns:

The attributionToken.

getAttributionTokenBytes

public com.google.protobuf.ByteString getAttributionTokenBytes()

 A unique attribution token. This should be included in the
 [UserEvent][google.cloud.discoveryengine.v1alpha.UserEvent] logs resulting
 from this recommendation, which enables accurate attribution of
 recommendation model performance.
 

string attribution_token = 2;

Specified by:

getAttributionTokenBytes in interface RecommendResponseOrBuilder

Returns:

The bytes for attributionToken.

getMissingIdsList

public com.google.protobuf.ProtocolStringList getMissingIdsList()

 IDs of documents in the request that were missing from the default Branch
 associated with the requested ServingConfig.
 

repeated string missing_ids = 3;

Specified by:

getMissingIdsList in interface RecommendResponseOrBuilder

Returns:

A list containing the missingIds.

getMissingIdsCount

public int getMissingIdsCount()

 IDs of documents in the request that were missing from the default Branch
 associated with the requested ServingConfig.
 

repeated string missing_ids = 3;

Specified by:

getMissingIdsCount in interface RecommendResponseOrBuilder

Returns:

The count of missingIds.

getMissingIds

public String getMissingIds(int index)

 IDs of documents in the request that were missing from the default Branch
 associated with the requested ServingConfig.
 

repeated string missing_ids = 3;

Specified by:

getMissingIds in interface RecommendResponseOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The missingIds at the given index.

getMissingIdsBytes

public com.google.protobuf.ByteString getMissingIdsBytes(int index)

 IDs of documents in the request that were missing from the default Branch
 associated with the requested ServingConfig.
 

repeated string missing_ids = 3;

Specified by:

getMissingIdsBytes in interface RecommendResponseOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the missingIds at the given index.

getValidateOnly

public boolean getValidateOnly()

 True if
 [RecommendRequest.validate_only][google.cloud.discoveryengine.v1alpha.RecommendRequest.validate_only]
 was set.
 

bool validate_only = 4;

Specified by:

getValidateOnly in interface RecommendResponseOrBuilder

Returns:

The validateOnly.

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RecommendResponse 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 parseFrom(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RecommendResponse parseFrom(InputStream input)
                                   throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static RecommendResponse parseDelimitedFrom(InputStream input)
                                            throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public RecommendResponse.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RecommendResponse.Builder newBuilder()

newBuilder

public static RecommendResponse.Builder newBuilder(RecommendResponse prototype)

toBuilder

public RecommendResponse.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RecommendResponse getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder