com.google.cloud.retail.v2alpha

Interface PredictResponseOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

PredictResponse, PredictResponse.Builder

public interface PredictResponseOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAttributionToken() A unique attribution token.
com.google.protobuf.ByteString	getAttributionTokenBytes() A unique attribution token.
String	getMissingIds(int index) IDs of products in the request that were missing from the inventory.
com.google.protobuf.ByteString	getMissingIdsBytes(int index) IDs of products in the request that were missing from the inventory.
int	getMissingIdsCount() IDs of products in the request that were missing from the inventory.
List<String>	getMissingIdsList() IDs of products in the request that were missing from the inventory.
PredictResponse.PredictionResult	getResults(int index) A list of recommended products.
int	getResultsCount() A list of recommended products.
List<PredictResponse.PredictionResult>	getResultsList() A list of recommended products.
PredictResponse.PredictionResultOrBuilder	getResultsOrBuilder(int index) A list of recommended products.
List<? extends PredictResponse.PredictionResultOrBuilder>	getResultsOrBuilderList() A list of recommended products.
boolean	getValidateOnly() True if the validateOnly property was set in the request.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getResultsList

List<PredictResponse.PredictionResult> getResultsList()

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

repeated .google.cloud.retail.v2alpha.PredictResponse.PredictionResult results = 1;

getResults

PredictResponse.PredictionResult getResults(int index)

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

repeated .google.cloud.retail.v2alpha.PredictResponse.PredictionResult results = 1;

getResultsCount

int getResultsCount()

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

repeated .google.cloud.retail.v2alpha.PredictResponse.PredictionResult results = 1;

getResultsOrBuilderList

List<? extends PredictResponse.PredictionResultOrBuilder> getResultsOrBuilderList()

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

repeated .google.cloud.retail.v2alpha.PredictResponse.PredictionResult results = 1;

getResultsOrBuilder

PredictResponse.PredictionResultOrBuilder getResultsOrBuilder(int index)

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

repeated .google.cloud.retail.v2alpha.PredictResponse.PredictionResult results = 1;

getAttributionToken

String getAttributionToken()

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

string attribution_token = 2;

Returns:

The attributionToken.

getAttributionTokenBytes

com.google.protobuf.ByteString getAttributionTokenBytes()

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

string attribution_token = 2;

Returns:

The bytes for attributionToken.

getMissingIdsList

List<String> getMissingIdsList()

 IDs of products in the request that were missing from the inventory.
 

repeated string missing_ids = 3;

Returns:

A list containing the missingIds.

getMissingIdsCount

int getMissingIdsCount()

 IDs of products in the request that were missing from the inventory.
 

repeated string missing_ids = 3;

Returns:

The count of missingIds.

getMissingIds

String getMissingIds(int index)

 IDs of products in the request that were missing from the inventory.
 

repeated string missing_ids = 3;

Parameters:

index - The index of the element to return.

Returns:

The missingIds at the given index.

getMissingIdsBytes

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

 IDs of products in the request that were missing from the inventory.
 

repeated string missing_ids = 3;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the missingIds at the given index.

getValidateOnly

boolean getValidateOnly()

 True if the validateOnly property was set in the request.
 

bool validate_only = 4;

Returns:

The validateOnly.