Package com.google.cloud.recommendationengine.v1beta1

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
    Description
    boolean
    containsItemMetadata(String key)
    Additional item metadata / annotations.
    String
    getId()
    ID of the recommended catalog item
    com.google.protobuf.ByteString
    getIdBytes()
    ID of the recommended catalog item
    Map<String,com.google.protobuf.Value>
    getItemMetadata()
    Deprecated.
    int
    getItemMetadataCount()
    Additional item metadata / annotations.
    Map<String,com.google.protobuf.Value>
    getItemMetadataMap()
    Additional item metadata / annotations.
    com.google.protobuf.Value
    getItemMetadataOrDefault(String key, com.google.protobuf.Value defaultValue)
    Additional item metadata / annotations.
    com.google.protobuf.Value
    getItemMetadataOrThrow(String key)
    Additional item metadata / annotations.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getId

      String getId()
       ID of the recommended catalog item
      string id = 1;
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
       ID of the recommended catalog item
      string id = 1;
      Returns:
      The bytes for id.

    • getItemMetadataCount

      int getItemMetadataCount()
       Additional item metadata / annotations.

 Possible values:

 * `catalogItem`: JSON representation of the catalogItem. Will be set if
 `returnCatalogItem` is set to true in `PredictRequest.params`.
 * `score`: Prediction score in double value. Will be set if
 `returnItemScore` is set to true in `PredictRequest.params`.
      map<string, .google.protobuf.Value> item_metadata = 2;

    • containsItemMetadata

      boolean containsItemMetadata(String key)
       Additional item metadata / annotations.

 Possible values:

 * `catalogItem`: JSON representation of the catalogItem. Will be set if
 `returnCatalogItem` is set to true in `PredictRequest.params`.
 * `score`: Prediction score in double value. Will be set if
 `returnItemScore` is set to true in `PredictRequest.params`.
      map<string, .google.protobuf.Value> item_metadata = 2;

    • getItemMetadata

      @Deprecated Map<String,com.google.protobuf.Value> getItemMetadata()
      Deprecated.
      Use getItemMetadataMap() instead.

    • getItemMetadataMap

      Map<String,com.google.protobuf.Value> getItemMetadataMap()
       Additional item metadata / annotations.

 Possible values:

 * `catalogItem`: JSON representation of the catalogItem. Will be set if
 `returnCatalogItem` is set to true in `PredictRequest.params`.
 * `score`: Prediction score in double value. Will be set if
 `returnItemScore` is set to true in `PredictRequest.params`.
      map<string, .google.protobuf.Value> item_metadata = 2;

    • getItemMetadataOrDefault

      com.google.protobuf.Value getItemMetadataOrDefault(String key, com.google.protobuf.Value defaultValue)
       Additional item metadata / annotations.

 Possible values:

 * `catalogItem`: JSON representation of the catalogItem. Will be set if
 `returnCatalogItem` is set to true in `PredictRequest.params`.
 * `score`: Prediction score in double value. Will be set if
 `returnItemScore` is set to true in `PredictRequest.params`.
      map<string, .google.protobuf.Value> item_metadata = 2;

    • getItemMetadataOrThrow

      com.google.protobuf.Value getItemMetadataOrThrow(String key)
       Additional item metadata / annotations.

 Possible values:

 * `catalogItem`: JSON representation of the catalogItem. Will be set if
 `returnCatalogItem` is set to true in `PredictRequest.params`.
 * `score`: Prediction score in double value. Will be set if
 `returnItemScore` is set to true in `PredictRequest.params`.
      map<string, .google.protobuf.Value> item_metadata = 2;