com.google.api.services.retail.v2.model.GoogleCloudRetailV2PredictResponsePredictionResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-retail Show documentation
There is a newer version: v2-rev20241220-2.0.0
Show newest version
/*
 * 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
 *
 * http://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.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.retail.v2.model;

/**
 * PredictionResult represents the recommendation prediction results.
 *
 *  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Retail API. For a detailed explanation see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class GoogleCloudRetailV2PredictResponsePredictionResult extends com.google.api.client.json.GenericJson {

  /**
   * ID of the recommended product
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String id;

  /**
   * 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`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map metadata;

  /**
   * ID of the recommended product
   * @return value or {@code null} for none
   */
  public java.lang.String getId() {
    return id;
  }

  /**
   * ID of the recommended product
   * @param id id or {@code null} for none
   */
  public GoogleCloudRetailV2PredictResponsePredictionResult setId(java.lang.String id) {
    this.id = id;
    return this;
  }

  /**
   * 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`.
   * @return value or {@code null} for none
   */
  public java.util.Map getMetadata() {
    return metadata;
  }

  /**
   * 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`.
   * @param metadata metadata or {@code null} for none
   */
  public GoogleCloudRetailV2PredictResponsePredictionResult setMetadata(java.util.Map metadata) {
    this.metadata = metadata;
    return this;
  }

  @Override
  public GoogleCloudRetailV2PredictResponsePredictionResult set(String fieldName, Object value) {
    return (GoogleCloudRetailV2PredictResponsePredictionResult) super.set(fieldName, value);
  }

  @Override
  public GoogleCloudRetailV2PredictResponsePredictionResult clone() {
    return (GoogleCloudRetailV2PredictResponsePredictionResult) super.clone();
  }

}