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

/**
 * This protocol buffer is used to represent telephone numbers and related information.
 *
 * <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 GeostoreTelephoneProto extends com.google.api.client.json.GenericJson {

  /**
   * RESERVED
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<GeostorePriceRangeProto> callRate;

  static {
    // hack to force ProGuard to consider GeostorePriceRangeProto used, since otherwise it would be stripped out
    // see https://github.com/google/google-api-java-client/issues/543
    com.google.api.client.util.Data.nullOf(GeostorePriceRangeProto.class);
  }

  /**
   * Disambiguates between the types of information or service a caller might seek when contacting
   * this phone number.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String contactCategory;

  /**
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<java.lang.String> flag;

  /**
   * True if this phone number is not unique to this establishment and might be shared with other
   * features. In case an establishment shares a phone number with a business chain of which it is a
   * member, and the number canonically belongs to that chain, it should be marked as shared for the
   * establishment but not shared for the chain.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean isSharedNumber;

  /**
   * RESERVED
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<GeostoreNameProto> label;

  static {
    // hack to force ProGuard to consider GeostoreNameProto used, since otherwise it would be stripped out
    // see https://github.com/google/google-api-java-client/issues/543
    com.google.api.client.util.Data.nullOf(GeostoreNameProto.class);
  }

  /**
   * RESERVED
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<java.lang.String> language;

  /**
   * Field-level metadata for this telephone number.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GeostoreFieldMetadataProto metadata;

  /**
   * ** DEPRECATED ** This is deprecated in favor of phone_number below. An internationalized
   * representation of a phone number. See //location/country/telephonenumber.proto
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private TelephoneNumber number;

  /**
   * An internationalized representation of a phone number. See
   * //java/com/google/i18n/phonenumbers/phonenumber.proto
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private I18nPhonenumbersPhoneNumber phoneNumber;

  /**
   * The features from which this phone number can be called from. For instance, if a phone number
   * can only be called from Europe, this field will contain a reference to the TYPE_CONTINENT
   * feature of Europe. This field is analogous to
   * http://kg/schema/common/phone_number/service_location. The only valid destination feature types
   * are TYPE_CONTINENT and TYPE_POLITICAL. If empty, this phone number can be called from anywhere
   * in Earth (this is the case for the majority of phones).
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<GeostoreFeatureIdProto> serviceLocationFeature;

  static {
    // hack to force ProGuard to consider GeostoreFeatureIdProto used, since otherwise it would be stripped out
    // see https://github.com/google/google-api-java-client/issues/543
    com.google.api.client.util.Data.nullOf(GeostoreFeatureIdProto.class);
  }

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

  /**
   * RESERVED
   * @return value or {@code null} for none
   */
  public java.util.List<GeostorePriceRangeProto> getCallRate() {
    return callRate;
  }

  /**
   * RESERVED
   * @param callRate callRate or {@code null} for none
   */
  public GeostoreTelephoneProto setCallRate(java.util.List<GeostorePriceRangeProto> callRate) {
    this.callRate = callRate;
    return this;
  }

  /**
   * Disambiguates between the types of information or service a caller might seek when contacting
   * this phone number.
   * @return value or {@code null} for none
   */
  public java.lang.String getContactCategory() {
    return contactCategory;
  }

  /**
   * Disambiguates between the types of information or service a caller might seek when contacting
   * this phone number.
   * @param contactCategory contactCategory or {@code null} for none
   */
  public GeostoreTelephoneProto setContactCategory(java.lang.String contactCategory) {
    this.contactCategory = contactCategory;
    return this;
  }

  /**
   * @return value or {@code null} for none
   */
  public java.util.List<java.lang.String> getFlag() {
    return flag;
  }

  /**
   * @param flag flag or {@code null} for none
   */
  public GeostoreTelephoneProto setFlag(java.util.List<java.lang.String> flag) {
    this.flag = flag;
    return this;
  }

  /**
   * True if this phone number is not unique to this establishment and might be shared with other
   * features. In case an establishment shares a phone number with a business chain of which it is a
   * member, and the number canonically belongs to that chain, it should be marked as shared for the
   * establishment but not shared for the chain.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getIsSharedNumber() {
    return isSharedNumber;
  }

  /**
   * True if this phone number is not unique to this establishment and might be shared with other
   * features. In case an establishment shares a phone number with a business chain of which it is a
   * member, and the number canonically belongs to that chain, it should be marked as shared for the
   * establishment but not shared for the chain.
   * @param isSharedNumber isSharedNumber or {@code null} for none
   */
  public GeostoreTelephoneProto setIsSharedNumber(java.lang.Boolean isSharedNumber) {
    this.isSharedNumber = isSharedNumber;
    return this;
  }

  /**
   * RESERVED
   * @return value or {@code null} for none
   */
  public java.util.List<GeostoreNameProto> getLabel() {
    return label;
  }

  /**
   * RESERVED
   * @param label label or {@code null} for none
   */
  public GeostoreTelephoneProto setLabel(java.util.List<GeostoreNameProto> label) {
    this.label = label;
    return this;
  }

  /**
   * RESERVED
   * @return value or {@code null} for none
   */
  public java.util.List<java.lang.String> getLanguage() {
    return language;
  }

  /**
   * RESERVED
   * @param language language or {@code null} for none
   */
  public GeostoreTelephoneProto setLanguage(java.util.List<java.lang.String> language) {
    this.language = language;
    return this;
  }

  /**
   * Field-level metadata for this telephone number.
   * @return value or {@code null} for none
   */
  public GeostoreFieldMetadataProto getMetadata() {
    return metadata;
  }

  /**
   * Field-level metadata for this telephone number.
   * @param metadata metadata or {@code null} for none
   */
  public GeostoreTelephoneProto setMetadata(GeostoreFieldMetadataProto metadata) {
    this.metadata = metadata;
    return this;
  }

  /**
   * ** DEPRECATED ** This is deprecated in favor of phone_number below. An internationalized
   * representation of a phone number. See //location/country/telephonenumber.proto
   * @return value or {@code null} for none
   */
  public TelephoneNumber getNumber() {
    return number;
  }

  /**
   * ** DEPRECATED ** This is deprecated in favor of phone_number below. An internationalized
   * representation of a phone number. See //location/country/telephonenumber.proto
   * @param number number or {@code null} for none
   */
  public GeostoreTelephoneProto setNumber(TelephoneNumber number) {
    this.number = number;
    return this;
  }

  /**
   * An internationalized representation of a phone number. See
   * //java/com/google/i18n/phonenumbers/phonenumber.proto
   * @return value or {@code null} for none
   */
  public I18nPhonenumbersPhoneNumber getPhoneNumber() {
    return phoneNumber;
  }

  /**
   * An internationalized representation of a phone number. See
   * //java/com/google/i18n/phonenumbers/phonenumber.proto
   * @param phoneNumber phoneNumber or {@code null} for none
   */
  public GeostoreTelephoneProto setPhoneNumber(I18nPhonenumbersPhoneNumber phoneNumber) {
    this.phoneNumber = phoneNumber;
    return this;
  }

  /**
   * The features from which this phone number can be called from. For instance, if a phone number
   * can only be called from Europe, this field will contain a reference to the TYPE_CONTINENT
   * feature of Europe. This field is analogous to
   * http://kg/schema/common/phone_number/service_location. The only valid destination feature types
   * are TYPE_CONTINENT and TYPE_POLITICAL. If empty, this phone number can be called from anywhere
   * in Earth (this is the case for the majority of phones).
   * @return value or {@code null} for none
   */
  public java.util.List<GeostoreFeatureIdProto> getServiceLocationFeature() {
    return serviceLocationFeature;
  }

  /**
   * The features from which this phone number can be called from. For instance, if a phone number
   * can only be called from Europe, this field will contain a reference to the TYPE_CONTINENT
   * feature of Europe. This field is analogous to
   * http://kg/schema/common/phone_number/service_location. The only valid destination feature types
   * are TYPE_CONTINENT and TYPE_POLITICAL. If empty, this phone number can be called from anywhere
   * in Earth (this is the case for the majority of phones).
   * @param serviceLocationFeature serviceLocationFeature or {@code null} for none
   */
  public GeostoreTelephoneProto setServiceLocationFeature(java.util.List<GeostoreFeatureIdProto> serviceLocationFeature) {
    this.serviceLocationFeature = serviceLocationFeature;
    return this;
  }

  /**
   * @return value or {@code null} for none
   */
  public java.lang.String getType() {
    return type;
  }

  /**
   * @param type type or {@code null} for none
   */
  public GeostoreTelephoneProto setType(java.lang.String type) {
    this.type = type;
    return this;
  }

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

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

}
