com.google.api.services.retail.v2.model.GoogleCloudRetailV2PredictResponse 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;

/**
 * Response message for predict method.
 *
 *  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 GoogleCloudRetailV2PredictResponse extends com.google.api.client.json.GenericJson {

  /**
   * A unique attribution token. This should be included in the UserEvent logs resulting from this
   * recommendation, which enables accurate attribution of recommendation model performance.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String attributionToken;

  /**
   * IDs of products in the request that were missing from the inventory.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List missingIds;

  /**
   * A list of recommended products. The order represents the ranking (from the most relevant
   * product to the least).
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List results;

  /**
   * True if the validateOnly property was set in the request.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean validateOnly;

  /**
   * A unique attribution token. This should be included in the UserEvent logs resulting from this
   * recommendation, which enables accurate attribution of recommendation model performance.
   * @return value or {@code null} for none
   */
  public java.lang.String getAttributionToken() {
    return attributionToken;
  }

  /**
   * A unique attribution token. This should be included in the UserEvent logs resulting from this
   * recommendation, which enables accurate attribution of recommendation model performance.
   * @param attributionToken attributionToken or {@code null} for none
   */
  public GoogleCloudRetailV2PredictResponse setAttributionToken(java.lang.String attributionToken) {
    this.attributionToken = attributionToken;
    return this;
  }

  /**
   * IDs of products in the request that were missing from the inventory.
   * @return value or {@code null} for none
   */
  public java.util.List getMissingIds() {
    return missingIds;
  }

  /**
   * IDs of products in the request that were missing from the inventory.
   * @param missingIds missingIds or {@code null} for none
   */
  public GoogleCloudRetailV2PredictResponse setMissingIds(java.util.List missingIds) {
    this.missingIds = missingIds;
    return this;
  }

  /**
   * A list of recommended products. The order represents the ranking (from the most relevant
   * product to the least).
   * @return value or {@code null} for none
   */
  public java.util.List getResults() {
    return results;
  }

  /**
   * A list of recommended products. The order represents the ranking (from the most relevant
   * product to the least).
   * @param results results or {@code null} for none
   */
  public GoogleCloudRetailV2PredictResponse setResults(java.util.List results) {
    this.results = results;
    return this;
  }

  /**
   * True if the validateOnly property was set in the request.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getValidateOnly() {
    return validateOnly;
  }

  /**
   * True if the validateOnly property was set in the request.
   * @param validateOnly validateOnly or {@code null} for none
   */
  public GoogleCloudRetailV2PredictResponse setValidateOnly(java.lang.Boolean validateOnly) {
    this.validateOnly = validateOnly;
    return this;
  }

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

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

}