/*
 * 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;

/**
 * An entity, which may occur multiple times in the text.
 *
 * <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 NlxDataSchemaEntity extends com.google.api.client.json.GenericJson {

  /**
   * Entity gender. Default label set is 'masculine', 'feminine', or 'neuter'. (Perhaps in the
   * future we can split 'neuter' into 'inanimate', 'unknown', and 'non-binary'.)
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String gender;

  /**
   * Machine identifier, such as those from the Freebase database (or similar entity database).
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String mid;

  /**
   * Free-form entity name.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * Entity type, typically something like person/location/organization. The schema for types is not
   * specified. If this entity has a MID, use the mid field instead or in conjunction with the type.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<java.lang.String> type;

  /**
   * Entity gender. Default label set is 'masculine', 'feminine', or 'neuter'. (Perhaps in the
   * future we can split 'neuter' into 'inanimate', 'unknown', and 'non-binary'.)
   * @return value or {@code null} for none
   */
  public java.lang.String getGender() {
    return gender;
  }

  /**
   * Entity gender. Default label set is 'masculine', 'feminine', or 'neuter'. (Perhaps in the
   * future we can split 'neuter' into 'inanimate', 'unknown', and 'non-binary'.)
   * @param gender gender or {@code null} for none
   */
  public NlxDataSchemaEntity setGender(java.lang.String gender) {
    this.gender = gender;
    return this;
  }

  /**
   * Machine identifier, such as those from the Freebase database (or similar entity database).
   * @return value or {@code null} for none
   */
  public java.lang.String getMid() {
    return mid;
  }

  /**
   * Machine identifier, such as those from the Freebase database (or similar entity database).
   * @param mid mid or {@code null} for none
   */
  public NlxDataSchemaEntity setMid(java.lang.String mid) {
    this.mid = mid;
    return this;
  }

  /**
   * Free-form entity name.
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * Free-form entity name.
   * @param name name or {@code null} for none
   */
  public NlxDataSchemaEntity setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  /**
   * Entity type, typically something like person/location/organization. The schema for types is not
   * specified. If this entity has a MID, use the mid field instead or in conjunction with the type.
   * @return value or {@code null} for none
   */
  public java.util.List<java.lang.String> getType() {
    return type;
  }

  /**
   * Entity type, typically something like person/location/organization. The schema for types is not
   * specified. If this entity has a MID, use the mid field instead or in conjunction with the type.
   * @param type type or {@code null} for none
   */
  public NlxDataSchemaEntity setType(java.util.List<java.lang.String> type) {
    this.type = type;
    return this;
  }

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

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

}
