com.google.cloud.retail.v2

Interface PredictResponse.PredictionResultOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

PredictResponse.PredictionResult, PredictResponse.PredictionResult.Builder

Enclosing class:

PredictResponse

public static interface PredictResponse.PredictionResultOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsMetadata(String key) Additional product metadata / annotations.
String	getId() ID of the recommended product
com.google.protobuf.ByteString	getIdBytes() ID of the recommended product
Map<String,com.google.protobuf.Value>	getMetadata() Deprecated.
int	getMetadataCount() Additional product metadata / annotations.
Map<String,com.google.protobuf.Value>	getMetadataMap() Additional product metadata / annotations.
com.google.protobuf.Value	getMetadataOrDefault(String key, com.google.protobuf.Value defaultValue) Additional product metadata / annotations.
com.google.protobuf.Value	getMetadataOrThrow(String key) Additional product metadata / annotations.

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

getId

String getId()

 ID of the recommended product
 

string id = 1;

Returns:

The id.

getIdBytes

com.google.protobuf.ByteString getIdBytes()

 ID of the recommended product
 

string id = 1;

Returns:

The bytes for id.

getMetadataCount

int getMetadataCount()

 Additional product metadata / annotations.

 Possible values:

 * `product`: JSON representation of the product. Is set if
   `returnProduct` is set to true in `PredictRequest.params`.
 * `score`: Prediction score in double value. Is set if
   `returnScore` is set to true in `PredictRequest.params`.
 

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

containsMetadata

boolean containsMetadata(String key)

 Additional product metadata / annotations.

 Possible values:

 * `product`: JSON representation of the product. Is set if
   `returnProduct` is set to true in `PredictRequest.params`.
 * `score`: Prediction score in double value. Is set if
   `returnScore` is set to true in `PredictRequest.params`.
 

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

getMetadata

@Deprecated
Map<String,com.google.protobuf.Value> getMetadata()

Deprecated.

Use getMetadataMap() instead.

getMetadataMap

Map<String,com.google.protobuf.Value> getMetadataMap()

 Additional product metadata / annotations.

 Possible values:

 * `product`: JSON representation of the product. Is set if
   `returnProduct` is set to true in `PredictRequest.params`.
 * `score`: Prediction score in double value. Is set if
   `returnScore` is set to true in `PredictRequest.params`.
 

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

getMetadataOrDefault

com.google.protobuf.Value getMetadataOrDefault(String key,
                                               com.google.protobuf.Value defaultValue)

 Additional product metadata / annotations.

 Possible values:

 * `product`: JSON representation of the product. Is set if
   `returnProduct` is set to true in `PredictRequest.params`.
 * `score`: Prediction score in double value. Is set if
   `returnScore` is set to true in `PredictRequest.params`.
 

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

getMetadataOrThrow

com.google.protobuf.Value getMetadataOrThrow(String key)

 Additional product metadata / annotations.

 Possible values:

 * `product`: JSON representation of the product. Is set if
   `returnProduct` is set to true in `PredictRequest.params`.
 * `score`: Prediction score in double value. Is set if
   `returnScore` is set to true in `PredictRequest.params`.
 

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