Interface PredictResponseOrBuilder (0.41.0)

Version 0.41.0

• 0.62.0 (latest)
• 0.61.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.4
• 0.8.10

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
Name	Description
key	String

Returns
Type	Description
boolean

getDryRun()

public abstract boolean getDryRun()

True if the dryRun property was set in the request.

bool dry_run = 4;

Returns
Type	Description
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
Name	Description
index	int The index of the element to return.

Returns
Type	Description
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
Name	Description
index	int The index of the value to return.

Returns
Type	Description
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
Type	Description
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
Type	Description
List<String>	A list containing the itemsMissingInCatalog.

getMetadata() (deprecated)

public abstract Map<String,Value> getMetadata()

Use #getMetadataMap() instead.

Returns
Type	Description
Map<String,Value>

getMetadataCount()

public abstract int getMetadataCount()

Additional domain specific prediction response metadata.

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

Returns
Type	Description
int

getMetadataMap()

public abstract Map<String,Value> getMetadataMap()

Additional domain specific prediction response metadata.

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

Returns
Type	Description
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
Name	Description
key	String
defaultValue	Value

Returns
Type	Description
Value

getMetadataOrThrow(String key)

public abstract Value getMetadataOrThrow(String key)

Additional domain specific prediction response metadata.

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

Parameter
Name	Description
key	String

Returns
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Name	Description
index	int

Returns
Type	Description
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
Type	Description
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
Type	Description
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
Name	Description
index	int

Returns
Type	Description
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
Type	Description
List<? extends com.google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResultOrBuilder>