/*
 * 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.contentwarehouse.v1.model;

/**
 * Proto message containing the id, localized title, score, and hierarchy level of a trusted genome
 * entity. Next ID: 10
 *
 * <p> 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 Document AI Warehouse API. For a detailed explanation
 * see:
 * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
 * </p>
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class VendingConsumerProtoTrustedGenomeEntity extends com.google.api.client.json.GenericJson {

  /**
   * The category id matching this trusted genome entity. e.g. Action tag with id /m/025zzc matches
   * category of id GAME_ACTION
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String categoryId;

  /**
   * The identifier of a play trusted genome entity. Required.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String id;

  /**
   * The level of the entity. E.g. in hierarchy like Action -> Platformer > Endless Runner. Action
   * is level 1, Platformer is level 2 and Endless Runner is level 3. Currently, only APP_TAXONOMY
   * and GAME_TAXONOMY type may have the levels. For entity that does not have hierarchy, its level
   * is 1. Required.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer level;

  /**
   * The name of the relation between the app and the entity. Required.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String predicateName;

  /**
   * The localized query string for this trusted genome entity. This query will be used when we want
   * to bring users to SERP on click.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String queryText;

  /**
   * The confidence score of the entity to the app.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Float score;

  /**
   * The localized title. Required.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String title;

  /**
   * This boolean is used to decide whether this entity will be shown on user-facing features in the
   * Store or not.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean userVisible;

  /**
   * The category id matching this trusted genome entity. e.g. Action tag with id /m/025zzc matches
   * category of id GAME_ACTION
   * @return value or {@code null} for none
   */
  public java.lang.String getCategoryId() {
    return categoryId;
  }

  /**
   * The category id matching this trusted genome entity. e.g. Action tag with id /m/025zzc matches
   * category of id GAME_ACTION
   * @param categoryId categoryId or {@code null} for none
   */
  public VendingConsumerProtoTrustedGenomeEntity setCategoryId(java.lang.String categoryId) {
    this.categoryId = categoryId;
    return this;
  }

  /**
   * The identifier of a play trusted genome entity. Required.
   * @return value or {@code null} for none
   */
  public java.lang.String getId() {
    return id;
  }

  /**
   * The identifier of a play trusted genome entity. Required.
   * @param id id or {@code null} for none
   */
  public VendingConsumerProtoTrustedGenomeEntity setId(java.lang.String id) {
    this.id = id;
    return this;
  }

  /**
   * The level of the entity. E.g. in hierarchy like Action -> Platformer > Endless Runner. Action
   * is level 1, Platformer is level 2 and Endless Runner is level 3. Currently, only APP_TAXONOMY
   * and GAME_TAXONOMY type may have the levels. For entity that does not have hierarchy, its level
   * is 1. Required.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getLevel() {
    return level;
  }

  /**
   * The level of the entity. E.g. in hierarchy like Action -> Platformer > Endless Runner. Action
   * is level 1, Platformer is level 2 and Endless Runner is level 3. Currently, only APP_TAXONOMY
   * and GAME_TAXONOMY type may have the levels. For entity that does not have hierarchy, its level
   * is 1. Required.
   * @param level level or {@code null} for none
   */
  public VendingConsumerProtoTrustedGenomeEntity setLevel(java.lang.Integer level) {
    this.level = level;
    return this;
  }

  /**
   * The name of the relation between the app and the entity. Required.
   * @return value or {@code null} for none
   */
  public java.lang.String getPredicateName() {
    return predicateName;
  }

  /**
   * The name of the relation between the app and the entity. Required.
   * @param predicateName predicateName or {@code null} for none
   */
  public VendingConsumerProtoTrustedGenomeEntity setPredicateName(java.lang.String predicateName) {
    this.predicateName = predicateName;
    return this;
  }

  /**
   * The localized query string for this trusted genome entity. This query will be used when we want
   * to bring users to SERP on click.
   * @return value or {@code null} for none
   */
  public java.lang.String getQueryText() {
    return queryText;
  }

  /**
   * The localized query string for this trusted genome entity. This query will be used when we want
   * to bring users to SERP on click.
   * @param queryText queryText or {@code null} for none
   */
  public VendingConsumerProtoTrustedGenomeEntity setQueryText(java.lang.String queryText) {
    this.queryText = queryText;
    return this;
  }

  /**
   * The confidence score of the entity to the app.
   * @return value or {@code null} for none
   */
  public java.lang.Float getScore() {
    return score;
  }

  /**
   * The confidence score of the entity to the app.
   * @param score score or {@code null} for none
   */
  public VendingConsumerProtoTrustedGenomeEntity setScore(java.lang.Float score) {
    this.score = score;
    return this;
  }

  /**
   * The localized title. Required.
   * @return value or {@code null} for none
   */
  public java.lang.String getTitle() {
    return title;
  }

  /**
   * The localized title. Required.
   * @param title title or {@code null} for none
   */
  public VendingConsumerProtoTrustedGenomeEntity setTitle(java.lang.String title) {
    this.title = title;
    return this;
  }

  /**
   * This boolean is used to decide whether this entity will be shown on user-facing features in the
   * Store or not.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getUserVisible() {
    return userVisible;
  }

  /**
   * This boolean is used to decide whether this entity will be shown on user-facing features in the
   * Store or not.
   * @param userVisible userVisible or {@code null} for none
   */
  public VendingConsumerProtoTrustedGenomeEntity setUserVisible(java.lang.Boolean userVisible) {
    this.userVisible = userVisible;
    return this;
  }

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

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

}
