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
MISSING_IDS_FIELD_NUMBER
public static final int MISSING_IDS_FIELD_NUMBER
Field Value
RESULTS_FIELD_NUMBER
public static final int RESULTS_FIELD_NUMBER
Field Value
VALIDATE_ONLY_FIELD_NUMBER
public static final int VALIDATE_ONLY_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static RecommendResponse getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static RecommendResponse.Builder newBuilder()
Returns
newBuilder(RecommendResponse prototype)
public static RecommendResponse.Builder newBuilder(RecommendResponse prototype)
Parameter
Returns
public static RecommendResponse parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static RecommendResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static RecommendResponse parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RecommendResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static RecommendResponse parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RecommendResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RecommendResponse parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static RecommendResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RecommendResponse parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static RecommendResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static RecommendResponse parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RecommendResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<RecommendResponse> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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;
| Type | Description |
| 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;
| Type | Description |
| ByteString | The bytes for attributionToken.
|
getDefaultInstanceForType()
public RecommendResponse getDefaultInstanceForType()
Returns
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;
| Name | Description |
| index | int
The index of the element to return.
|
Returns
| Type | Description |
| 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;
| Name | Description |
| index | int
The index of the value to return.
|
Returns
| Type | Description |
| 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;
| Type | Description |
| 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;
getParserForType()
public Parser<RecommendResponse> getParserForType()
Returns
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;
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;
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;
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;
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;
| Type | Description |
| List<? extends com.google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResultOrBuilder> | |
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getValidateOnly()
public boolean getValidateOnly()
True if
RecommendRequest.validate_only
was set.
bool validate_only = 4;
| Type | Description |
| boolean | The validateOnly.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public RecommendResponse.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RecommendResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public RecommendResponse.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
