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

/**
 * The rating of a Product.
 *
 *  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 Vertex AI Search for 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 GoogleCloudRetailV2Rating extends com.google.api.client.json.GenericJson {

  /**
   * The average rating of the Product. The rating is scaled at 1-5. Otherwise, an INVALID_ARGUMENT
   * error is returned.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Float averageRating;

  /**
   * The total number of ratings. This value is independent of the value of rating_histogram. This
   * value must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer ratingCount;

  /**
   * List of rating counts per rating value (index = rating - 1). The list is empty if there is no
   * rating. If the list is non-empty, its size is always 5. Otherwise, an INVALID_ARGUMENT error is
   * returned. For example, [41, 14, 13, 47, 303]. It means that the Product got 41 ratings with 1
   * star, 14 ratings with 2 star, and so on.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List ratingHistogram;

  /**
   * The average rating of the Product. The rating is scaled at 1-5. Otherwise, an INVALID_ARGUMENT
   * error is returned.
   * @return value or {@code null} for none
   */
  public java.lang.Float getAverageRating() {
    return averageRating;
  }

  /**
   * The average rating of the Product. The rating is scaled at 1-5. Otherwise, an INVALID_ARGUMENT
   * error is returned.
   * @param averageRating averageRating or {@code null} for none
   */
  public GoogleCloudRetailV2Rating setAverageRating(java.lang.Float averageRating) {
    this.averageRating = averageRating;
    return this;
  }

  /**
   * The total number of ratings. This value is independent of the value of rating_histogram. This
   * value must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getRatingCount() {
    return ratingCount;
  }

  /**
   * The total number of ratings. This value is independent of the value of rating_histogram. This
   * value must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.
   * @param ratingCount ratingCount or {@code null} for none
   */
  public GoogleCloudRetailV2Rating setRatingCount(java.lang.Integer ratingCount) {
    this.ratingCount = ratingCount;
    return this;
  }

  /**
   * List of rating counts per rating value (index = rating - 1). The list is empty if there is no
   * rating. If the list is non-empty, its size is always 5. Otherwise, an INVALID_ARGUMENT error is
   * returned. For example, [41, 14, 13, 47, 303]. It means that the Product got 41 ratings with 1
   * star, 14 ratings with 2 star, and so on.
   * @return value or {@code null} for none
   */
  public java.util.List getRatingHistogram() {
    return ratingHistogram;
  }

  /**
   * List of rating counts per rating value (index = rating - 1). The list is empty if there is no
   * rating. If the list is non-empty, its size is always 5. Otherwise, an INVALID_ARGUMENT error is
   * returned. For example, [41, 14, 13, 47, 303]. It means that the Product got 41 ratings with 1
   * star, 14 ratings with 2 star, and so on.
   * @param ratingHistogram ratingHistogram or {@code null} for none
   */
  public GoogleCloudRetailV2Rating setRatingHistogram(java.util.List ratingHistogram) {
    this.ratingHistogram = ratingHistogram;
    return this;
  }

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

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

}