public final class RecommendResponse extends GeneratedMessageV3 implements RecommendResponseOrBuilder
Response message for Recommend method.
Protobuf type google.cloud.discoveryengine.v1.RecommendResponse
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ATTRIBUTION_TOKEN_FIELD_NUMBER
public static final int ATTRIBUTION_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MISSING_IDS_FIELD_NUMBER
public static final int MISSING_IDS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESULTS_FIELD_NUMBER
public static final int RESULTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
VALIDATE_ONLY_FIELD_NUMBER
public static final int VALIDATE_ONLY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static RecommendResponse getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static RecommendResponse.Builder newBuilder()
newBuilder(RecommendResponse prototype)
public static RecommendResponse.Builder newBuilder(RecommendResponse prototype)
public static RecommendResponse parseDelimitedFrom(InputStream input)
public static RecommendResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static RecommendResponse parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RecommendResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static RecommendResponse parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RecommendResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RecommendResponse parseFrom(CodedInputStream input)
public static RecommendResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RecommendResponse parseFrom(InputStream input)
public static RecommendResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static RecommendResponse parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RecommendResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<RecommendResponse> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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 |
| 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;
| Returns |
| Type |
Description |
ByteString |
The bytes for attributionToken.
|
getDefaultInstanceForType()
public RecommendResponse getDefaultInstanceForType()
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 |
| 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;
| Parameter |
| 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;
| Returns |
| 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()
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.v1.RecommendResponse.RecommendationResult results = 1;
| Parameter |
| Name |
Description |
index |
int
|
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.v1.RecommendResponse.RecommendationResult results = 1;
| Returns |
| Type |
Description |
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.v1.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.v1.RecommendResponse.RecommendationResult results = 1;
| Parameter |
| Name |
Description |
index |
int
|
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.v1.RecommendResponse.RecommendationResult results = 1;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.discoveryengine.v1.RecommendResponse.RecommendationResultOrBuilder> |
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getValidateOnly()
public boolean getValidateOnly()
True if
RecommendRequest.validate_only
was set.
bool validate_only = 4;
| Returns |
| Type |
Description |
boolean |
The validateOnly.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public RecommendResponse.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RecommendResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public RecommendResponse.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
