Class RecommendResponse (0.25.0)

public final class RecommendResponse extends GeneratedMessageV3 implements RecommendResponseOrBuilder

Response message for Recommend method.

Protobuf type google.cloud.discoveryengine.v1beta.RecommendResponse

Static Fields

ATTRIBUTION_TOKEN_FIELD_NUMBER

public static final int ATTRIBUTION_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

MISSING_IDS_FIELD_NUMBER

public static final int MISSING_IDS_FIELD_NUMBER
Field Value
TypeDescription
int

RESULTS_FIELD_NUMBER

public static final int RESULTS_FIELD_NUMBER
Field Value
TypeDescription
int

VALIDATE_ONLY_FIELD_NUMBER

public static final int VALIDATE_ONLY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static RecommendResponse getDefaultInstance()
Returns
TypeDescription
RecommendResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static RecommendResponse.Builder newBuilder()
Returns
TypeDescription
RecommendResponse.Builder

newBuilder(RecommendResponse prototype)

public static RecommendResponse.Builder newBuilder(RecommendResponse prototype)
Parameter
NameDescription
prototypeRecommendResponse
Returns
TypeDescription
RecommendResponse.Builder

parseDelimitedFrom(InputStream input)

public static RecommendResponse parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RecommendResponse
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RecommendResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecommendResponse
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RecommendResponse parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RecommendResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RecommendResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecommendResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RecommendResponse parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RecommendResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RecommendResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecommendResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RecommendResponse parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RecommendResponse
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RecommendResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecommendResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RecommendResponse parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RecommendResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RecommendResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecommendResponse
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RecommendResponse parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RecommendResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RecommendResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RecommendResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RecommendResponse> parser()
Returns
TypeDescription
Parser<RecommendResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAttributionToken()

public String getAttributionToken()

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

string attribution_token = 2;

Returns
TypeDescription
String

The attributionToken.

getAttributionTokenBytes()

public ByteString getAttributionTokenBytes()

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

string attribution_token = 2;

Returns
TypeDescription
ByteString

The bytes for attributionToken.

getDefaultInstanceForType()

public RecommendResponse getDefaultInstanceForType()
Returns
TypeDescription
RecommendResponse

getMissingIds(int index)

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;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The missingIds at the given index.

getMissingIdsBytes(int index)

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

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the missingIds at the given index.

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;

Returns
TypeDescription
int

The count of missingIds.

getMissingIdsList()

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

Returns
TypeDescription
ProtocolStringList

A list containing the missingIds.

getParserForType()

public Parser<RecommendResponse> getParserForType()
Returns
TypeDescription
Parser<RecommendResponse>
Overrides

getResults(int index)

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.v1beta.RecommendResponse.RecommendationResult results = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
RecommendResponse.RecommendationResult

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.v1beta.RecommendResponse.RecommendationResult results = 1;

Returns
TypeDescription
int

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.v1beta.RecommendResponse.RecommendationResult results = 1;

Returns
TypeDescription
List<RecommendationResult>

getResultsOrBuilder(int index)

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.v1beta.RecommendResponse.RecommendationResult results = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
RecommendResponse.RecommendationResultOrBuilder

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.v1beta.RecommendResponse.RecommendationResult results = 1;

Returns
TypeDescription
List<? extends com.google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResultOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getValidateOnly()

public boolean getValidateOnly()

True if RecommendRequest.validate_only was set.

bool validate_only = 4;

Returns
TypeDescription
boolean

The validateOnly.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public RecommendResponse.Builder newBuilderForType()
Returns
TypeDescription
RecommendResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RecommendResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RecommendResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public RecommendResponse.Builder toBuilder()
Returns
TypeDescription
RecommendResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException