Package com.google.cloud.recommendationengine.v1beta1

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 Detail

      • getResultsList

        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;

      • getResults

        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;

      • getResultsCount

        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;

      • getResultsOrBuilderList

        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;

      • getResultsOrBuilder

        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;

      • getRecommendationToken

        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:
        The recommendationToken.

      • getRecommendationTokenBytes

        com.google.protobuf.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:
        The bytes for recommendationToken.

      • getItemsMissingInCatalogList

        List<String> getItemsMissingInCatalogList()
         IDs of items in the request that were missing from the catalog.
        repeated string items_missing_in_catalog = 3;
        Returns:
        A list containing the itemsMissingInCatalog.

      • getItemsMissingInCatalogCount

        int getItemsMissingInCatalogCount()
         IDs of items in the request that were missing from the catalog.
        repeated string items_missing_in_catalog = 3;
        Returns:
        The count of itemsMissingInCatalog.

      • getItemsMissingInCatalog

        String getItemsMissingInCatalog​(int index)
         IDs of items in the request that were missing from the catalog.
        repeated string items_missing_in_catalog = 3;
        Parameters:
        index - The index of the element to return.
        Returns:
        The itemsMissingInCatalog at the given index.

      • getItemsMissingInCatalogBytes

        com.google.protobuf.ByteString getItemsMissingInCatalogBytes​(int index)
         IDs of items in the request that were missing from the catalog.
        repeated string items_missing_in_catalog = 3;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the itemsMissingInCatalog at the given index.

      • getDryRun

        boolean getDryRun()
         True if the dryRun property was set in the request.
        bool dry_run = 4;
        Returns:
        The dryRun.

      • getMetadataCount

        int getMetadataCount()
         Additional domain specific prediction response metadata.
        map<string, .google.protobuf.Value> metadata = 5;

      • containsMetadata

        boolean containsMetadata​(String key)
         Additional domain specific prediction response metadata.
        map<string, .google.protobuf.Value> metadata = 5;

      • getMetadataMap

        Map<String,​com.google.protobuf.Value> getMetadataMap()
         Additional domain specific prediction response metadata.
        map<string, .google.protobuf.Value> metadata = 5;

      • getMetadataOrDefault

        com.google.protobuf.Value getMetadataOrDefault​(String key,
                                               com.google.protobuf.Value defaultValue)
         Additional domain specific prediction response metadata.
        map<string, .google.protobuf.Value> metadata = 5;

      • getMetadataOrThrow

        com.google.protobuf.Value getMetadataOrThrow​(String key)
         Additional domain specific prediction response metadata.
        map<string, .google.protobuf.Value> metadata = 5;

      • getNextPageToken

        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:
        The nextPageToken.

      • getNextPageTokenBytes

        com.google.protobuf.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:
        The bytes for nextPageToken.