com.google.cloud.recommendationengine.v1beta1.PredictResponseOrBuilder Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/recommendationengine/v1beta1/prediction_service.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.recommendationengine.v1beta1;

public interface PredictResponseOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.recommendationengine.v1beta1.PredictResponse)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * 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;
   * 
   */
  java.util.List
      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;
   * 
   */
  com.google.cloud.recommendationengine.v1beta1.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;
   * 
   */
  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;
   * 
   */
  java.util.List<
          ? extends
              com.google.cloud.recommendationengine.v1beta1.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;
   * 
   */
  com.google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResultOrBuilder
      getResultsOrBuilder(int index);

  /**
   *
   *
   *    * 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;
   *
   * @return The recommendationToken.
   */
  java.lang.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;
   *
   * @return The bytes for recommendationToken.
   */
  com.google.protobuf.ByteString getRecommendationTokenBytes();

  /**
   *
   *
   *    * IDs of items in the request that were missing from the catalog.
   * 
   *
   * repeated string items_missing_in_catalog = 3;
   *
   * @return A list containing the itemsMissingInCatalog.
   */
  java.util.List getItemsMissingInCatalogList();
  /**
   *
   *
   *    * IDs of items in the request that were missing from the catalog.
   * 
   *
   * repeated string items_missing_in_catalog = 3;
   *
   * @return The count of itemsMissingInCatalog.
   */
  int getItemsMissingInCatalogCount();
  /**
   *
   *
   *    * IDs of items in the request that were missing from the catalog.
   * 
   *
   * repeated string items_missing_in_catalog = 3;
   *
   * @param index The index of the element to return.
   * @return The itemsMissingInCatalog at the given index.
   */
  java.lang.String getItemsMissingInCatalog(int index);
  /**
   *
   *
   *    * IDs of items in the request that were missing from the catalog.
   * 
   *
   * repeated string items_missing_in_catalog = 3;
   *
   * @param index The index of the value to return.
   * @return The bytes of the itemsMissingInCatalog at the given index.
   */
  com.google.protobuf.ByteString getItemsMissingInCatalogBytes(int index);

  /**
   *
   *
   *    * True if the dryRun property was set in the request.
   * 
   *
   * bool dry_run = 4;
   *
   * @return The dryRun.
   */
  boolean getDryRun();

  /**
   *
   *
   *    * Additional domain specific prediction response metadata.
   * 
   *
   * map<string, .google.protobuf.Value> metadata = 5;
   */
  int getMetadataCount();
  /**
   *
   *
   *    * Additional domain specific prediction response metadata.
   * 
   *
   * map<string, .google.protobuf.Value> metadata = 5;
   */
  boolean containsMetadata(java.lang.String key);
  /** Use {@link #getMetadataMap()} instead. */
  @java.lang.Deprecated
  java.util.Map getMetadata();
  /**
   *
   *
   *    * Additional domain specific prediction response metadata.
   * 
   *
   * map<string, .google.protobuf.Value> metadata = 5;
   */
  java.util.Map getMetadataMap();
  /**
   *
   *
   *    * Additional domain specific prediction response metadata.
   * 
   *
   * map<string, .google.protobuf.Value> metadata = 5;
   */
  /* nullable */
  com.google.protobuf.Value getMetadataOrDefault(
      java.lang.String key,
      /* nullable */
      com.google.protobuf.Value defaultValue);
  /**
   *
   *
   *    * Additional domain specific prediction response metadata.
   * 
   *
   * map<string, .google.protobuf.Value> metadata = 5;
   */
  com.google.protobuf.Value getMetadataOrThrow(java.lang.String key);

  /**
   *
   *
   *    * 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;
   *
   * @return The nextPageToken.
   */
  java.lang.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;
   *
   * @return The bytes for nextPageToken.
   */
  com.google.protobuf.ByteString getNextPageTokenBytes();
}