Interface PredictResponseOrBuilder (0.30.0)

public interface PredictResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsMetadata(String key)

public abstract boolean containsMetadata(String key)

Additional domain specific prediction response metadata.

map<string, .google.protobuf.Value> metadata = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getDryRun()

public abstract boolean getDryRun()

True if the dryRun property was set in the request.

bool dry_run = 4;

Returns
TypeDescription
boolean

The dryRun.

getItemsMissingInCatalog(int index)

public abstract String getItemsMissingInCatalog(int index)

IDs of items in the request that were missing from the catalog.

repeated string items_missing_in_catalog = 3;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The itemsMissingInCatalog at the given index.

getItemsMissingInCatalogBytes(int index)

public abstract ByteString getItemsMissingInCatalogBytes(int index)

IDs of items in the request that were missing from the catalog.

repeated string items_missing_in_catalog = 3;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the itemsMissingInCatalog at the given index.

getItemsMissingInCatalogCount()

public abstract int getItemsMissingInCatalogCount()

IDs of items in the request that were missing from the catalog.

repeated string items_missing_in_catalog = 3;

Returns
TypeDescription
int

The count of itemsMissingInCatalog.

getItemsMissingInCatalogList()

public abstract List<String> getItemsMissingInCatalogList()

IDs of items in the request that were missing from the catalog.

repeated string items_missing_in_catalog = 3;

Returns
TypeDescription
List<String>

A list containing the itemsMissingInCatalog.

getMetadata()

public abstract Map<String,Value> getMetadata()

Use #getMetadataMap() instead.

Returns
TypeDescription
Map<String,Value>

getMetadataCount()

public abstract int getMetadataCount()

Additional domain specific prediction response metadata.

map<string, .google.protobuf.Value> metadata = 5;

Returns
TypeDescription
int

getMetadataMap()

public abstract Map<String,Value> getMetadataMap()

Additional domain specific prediction response metadata.

map<string, .google.protobuf.Value> metadata = 5;

Returns
TypeDescription
Map<String,Value>

getMetadataOrDefault(String key, Value defaultValue)

public abstract Value getMetadataOrDefault(String key, Value defaultValue)

Additional domain specific prediction response metadata.

map<string, .google.protobuf.Value> metadata = 5;

Parameters
NameDescription
keyString
defaultValueValue
Returns
TypeDescription
Value

getMetadataOrThrow(String key)

public abstract Value getMetadataOrThrow(String key)

Additional domain specific prediction response metadata.

map<string, .google.protobuf.Value> metadata = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
Value

getNextPageToken()

public abstract String getNextPageToken()

If empty, the list is complete. If nonempty, the token to pass to the next request's PredictRequest.page_token.

string next_page_token = 6;

Returns
TypeDescription
String

The nextPageToken.

getNextPageTokenBytes()

public abstract ByteString getNextPageTokenBytes()

If empty, the list is complete. If nonempty, the token to pass to the next request's PredictRequest.page_token.

string next_page_token = 6;

Returns
TypeDescription
ByteString

The bytes for nextPageToken.

getRecommendationToken()

public abstract String getRecommendationToken()

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

string recommendation_token = 2;

Returns
TypeDescription
String

The recommendationToken.

getRecommendationTokenBytes()

public abstract ByteString getRecommendationTokenBytes()

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

string recommendation_token = 2;

Returns
TypeDescription
ByteString

The bytes for recommendationToken.

getResults(int index)

public abstract PredictResponse.PredictionResult getResults(int index)

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

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
PredictResponse.PredictionResult

getResultsCount()

public abstract int getResultsCount()

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

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Returns
TypeDescription
int

getResultsList()

public abstract List<PredictResponse.PredictionResult> getResultsList()

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

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Returns
TypeDescription
List<PredictionResult>

getResultsOrBuilder(int index)

public abstract PredictResponse.PredictionResultOrBuilder getResultsOrBuilder(int index)

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

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
PredictResponse.PredictionResultOrBuilder

getResultsOrBuilderList()

public abstract List<? extends PredictResponse.PredictionResultOrBuilder> getResultsOrBuilderList()

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

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Returns
TypeDescription
List<? extends com.google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResultOrBuilder>