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

/**
 * A generic representation of a local result returned by a local backend. Next ID: 33
 *
 * <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 QualityDialogManagerLocalResult extends com.google.api.client.json.GenericJson {

  /**
   * This field can represent different areas depending on the country. For example in the US it is
   * state but in Canada it would be a province.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String adminArea1;

  /**
   * The set of available intents changes with result. An intersection of available_intents and
   * allowed_intents (See: local_config.proto), is shown to the user.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private QualityDialogManagerLocalIntentOptions availableIntents;

  /**
   * Bitset of business types this result falls into. Many fields in this message may be unset -
   * expect good coverage for restaurants and hotels for now, but not for other verticals.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private NlpSemanticParsingLocalBusinessType businessType;

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

  /**
   * The two-letter ISO 3166-1 country code of this result. Generated by FindFeatureCountryCode
   * http://google3/geostore/base/public/country.h?l=39=154898119 so it should always be populated,
   * but technically there is no guarantee.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String countryCode;

  /**
   * For a directions result, this field will be the distance from the origin to this result using
   * the best measure we have available - the distance along a route, if we have one, or just the
   * crow's flight distance. For a local result, this field will be the crow's flight distance from
   * the user to the result.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key @com.google.api.client.json.JsonString
  private java.math.BigInteger distanceMeters;

  /**
   * The standard units of the location where the user is based (not their current location). For
   * example, miles for a user from the US, kilometers for the UK. A US user currently in the UK
   * should have units read in miles.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String distanceUnits;

  /**
   * Various external IDs that we may have for this result.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private QualityDialogManagerExternalIds externalIds;

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

  /**
   * If true, this LocalResult is located in the same state as the user's location.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean inUserAdminArea1;

  /**
   * If true, this LocalResult is located in the same country as the user's location.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean inUserCountry;

  /**
   * Whether this result is in the same city or town that the user is in.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean inUserLocality;

  /**
   * Internal Food ordering action (i.e food ordering via Google) metadata.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private LocalsearchProtoInternalFoodOrderingActionMetadata internalFoodOrderingMetadata;

  /**
   * If the original query had a chain intent, and this result is for a business chain.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean isBusinessChain;

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

  /**
   * The name of the result, extracted from its FeatureProto's name field.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * Neighborhood within a city. This field is not likely to be set for towns or smaller cities.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String neighborhood;

  /**
   * All info we will need to lookup this result in search.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private NlpSemanticParsingLocalLocalResultId resultId;

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

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

  /**
   * A list of text synonyms the user could use to refer to the result.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<java.lang.String> synonym;

  /**
   * The address of this result formatted for TTS output. This formatting removes acronyms like
   * 2-letter state codes as they cannot be spoken well.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String ttsAddress;

  /**
   * This field can represent different areas depending on the country. For example in the US it is
   * state but in Canada it would be a province.
   * @return value or {@code null} for none
   */
  public java.lang.String getAdminArea1() {
    return adminArea1;
  }

  /**
   * This field can represent different areas depending on the country. For example in the US it is
   * state but in Canada it would be a province.
   * @param adminArea1 adminArea1 or {@code null} for none
   */
  public QualityDialogManagerLocalResult setAdminArea1(java.lang.String adminArea1) {
    this.adminArea1 = adminArea1;
    return this;
  }

  /**
   * The set of available intents changes with result. An intersection of available_intents and
   * allowed_intents (See: local_config.proto), is shown to the user.
   * @return value or {@code null} for none
   */
  public QualityDialogManagerLocalIntentOptions getAvailableIntents() {
    return availableIntents;
  }

  /**
   * The set of available intents changes with result. An intersection of available_intents and
   * allowed_intents (See: local_config.proto), is shown to the user.
   * @param availableIntents availableIntents or {@code null} for none
   */
  public QualityDialogManagerLocalResult setAvailableIntents(QualityDialogManagerLocalIntentOptions availableIntents) {
    this.availableIntents = availableIntents;
    return this;
  }

  /**
   * Bitset of business types this result falls into. Many fields in this message may be unset -
   * expect good coverage for restaurants and hotels for now, but not for other verticals.
   * @return value or {@code null} for none
   */
  public NlpSemanticParsingLocalBusinessType getBusinessType() {
    return businessType;
  }

  /**
   * Bitset of business types this result falls into. Many fields in this message may be unset -
   * expect good coverage for restaurants and hotels for now, but not for other verticals.
   * @param businessType businessType or {@code null} for none
   */
  public QualityDialogManagerLocalResult setBusinessType(NlpSemanticParsingLocalBusinessType businessType) {
    this.businessType = businessType;
    return this;
  }

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

  /**
   * @param country country or {@code null} for none
   */
  public QualityDialogManagerLocalResult setCountry(java.lang.String country) {
    this.country = country;
    return this;
  }

  /**
   * The two-letter ISO 3166-1 country code of this result. Generated by FindFeatureCountryCode
   * http://google3/geostore/base/public/country.h?l=39=154898119 so it should always be populated,
   * but technically there is no guarantee.
   * @return value or {@code null} for none
   */
  public java.lang.String getCountryCode() {
    return countryCode;
  }

  /**
   * The two-letter ISO 3166-1 country code of this result. Generated by FindFeatureCountryCode
   * http://google3/geostore/base/public/country.h?l=39=154898119 so it should always be populated,
   * but technically there is no guarantee.
   * @param countryCode countryCode or {@code null} for none
   */
  public QualityDialogManagerLocalResult setCountryCode(java.lang.String countryCode) {
    this.countryCode = countryCode;
    return this;
  }

  /**
   * For a directions result, this field will be the distance from the origin to this result using
   * the best measure we have available - the distance along a route, if we have one, or just the
   * crow's flight distance. For a local result, this field will be the crow's flight distance from
   * the user to the result.
   * @return value or {@code null} for none
   */
  public java.math.BigInteger getDistanceMeters() {
    return distanceMeters;
  }

  /**
   * For a directions result, this field will be the distance from the origin to this result using
   * the best measure we have available - the distance along a route, if we have one, or just the
   * crow's flight distance. For a local result, this field will be the crow's flight distance from
   * the user to the result.
   * @param distanceMeters distanceMeters or {@code null} for none
   */
  public QualityDialogManagerLocalResult setDistanceMeters(java.math.BigInteger distanceMeters) {
    this.distanceMeters = distanceMeters;
    return this;
  }

  /**
   * The standard units of the location where the user is based (not their current location). For
   * example, miles for a user from the US, kilometers for the UK. A US user currently in the UK
   * should have units read in miles.
   * @return value or {@code null} for none
   */
  public java.lang.String getDistanceUnits() {
    return distanceUnits;
  }

  /**
   * The standard units of the location where the user is based (not their current location). For
   * example, miles for a user from the US, kilometers for the UK. A US user currently in the UK
   * should have units read in miles.
   * @param distanceUnits distanceUnits or {@code null} for none
   */
  public QualityDialogManagerLocalResult setDistanceUnits(java.lang.String distanceUnits) {
    this.distanceUnits = distanceUnits;
    return this;
  }

  /**
   * Various external IDs that we may have for this result.
   * @return value or {@code null} for none
   */
  public QualityDialogManagerExternalIds getExternalIds() {
    return externalIds;
  }

  /**
   * Various external IDs that we may have for this result.
   * @param externalIds externalIds or {@code null} for none
   */
  public QualityDialogManagerLocalResult setExternalIds(QualityDialogManagerExternalIds externalIds) {
    this.externalIds = externalIds;
    return this;
  }

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

  /**
   * @param featureType featureType or {@code null} for none
   */
  public QualityDialogManagerLocalResult setFeatureType(java.lang.String featureType) {
    this.featureType = featureType;
    return this;
  }

  /**
   * If true, this LocalResult is located in the same state as the user's location.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getInUserAdminArea1() {
    return inUserAdminArea1;
  }

  /**
   * If true, this LocalResult is located in the same state as the user's location.
   * @param inUserAdminArea1 inUserAdminArea1 or {@code null} for none
   */
  public QualityDialogManagerLocalResult setInUserAdminArea1(java.lang.Boolean inUserAdminArea1) {
    this.inUserAdminArea1 = inUserAdminArea1;
    return this;
  }

  /**
   * If true, this LocalResult is located in the same country as the user's location.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getInUserCountry() {
    return inUserCountry;
  }

  /**
   * If true, this LocalResult is located in the same country as the user's location.
   * @param inUserCountry inUserCountry or {@code null} for none
   */
  public QualityDialogManagerLocalResult setInUserCountry(java.lang.Boolean inUserCountry) {
    this.inUserCountry = inUserCountry;
    return this;
  }

  /**
   * Whether this result is in the same city or town that the user is in.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getInUserLocality() {
    return inUserLocality;
  }

  /**
   * Whether this result is in the same city or town that the user is in.
   * @param inUserLocality inUserLocality or {@code null} for none
   */
  public QualityDialogManagerLocalResult setInUserLocality(java.lang.Boolean inUserLocality) {
    this.inUserLocality = inUserLocality;
    return this;
  }

  /**
   * Internal Food ordering action (i.e food ordering via Google) metadata.
   * @return value or {@code null} for none
   */
  public LocalsearchProtoInternalFoodOrderingActionMetadata getInternalFoodOrderingMetadata() {
    return internalFoodOrderingMetadata;
  }

  /**
   * Internal Food ordering action (i.e food ordering via Google) metadata.
   * @param internalFoodOrderingMetadata internalFoodOrderingMetadata or {@code null} for none
   */
  public QualityDialogManagerLocalResult setInternalFoodOrderingMetadata(LocalsearchProtoInternalFoodOrderingActionMetadata internalFoodOrderingMetadata) {
    this.internalFoodOrderingMetadata = internalFoodOrderingMetadata;
    return this;
  }

  /**
   * If the original query had a chain intent, and this result is for a business chain.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getIsBusinessChain() {
    return isBusinessChain;
  }

  /**
   * If the original query had a chain intent, and this result is for a business chain.
   * @param isBusinessChain isBusinessChain or {@code null} for none
   */
  public QualityDialogManagerLocalResult setIsBusinessChain(java.lang.Boolean isBusinessChain) {
    this.isBusinessChain = isBusinessChain;
    return this;
  }

  /**
   * City/Town.
   * @return value or {@code null} for none
   */
  public java.lang.String getLocality() {
    return locality;
  }

  /**
   * City/Town.
   * @param locality locality or {@code null} for none
   */
  public QualityDialogManagerLocalResult setLocality(java.lang.String locality) {
    this.locality = locality;
    return this;
  }

  /**
   * The name of the result, extracted from its FeatureProto's name field.
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * The name of the result, extracted from its FeatureProto's name field.
   * @param name name or {@code null} for none
   */
  public QualityDialogManagerLocalResult setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  /**
   * Neighborhood within a city. This field is not likely to be set for towns or smaller cities.
   * @return value or {@code null} for none
   */
  public java.lang.String getNeighborhood() {
    return neighborhood;
  }

  /**
   * Neighborhood within a city. This field is not likely to be set for towns or smaller cities.
   * @param neighborhood neighborhood or {@code null} for none
   */
  public QualityDialogManagerLocalResult setNeighborhood(java.lang.String neighborhood) {
    this.neighborhood = neighborhood;
    return this;
  }

  /**
   * All info we will need to lookup this result in search.
   * @return value or {@code null} for none
   */
  public NlpSemanticParsingLocalLocalResultId getResultId() {
    return resultId;
  }

  /**
   * All info we will need to lookup this result in search.
   * @param resultId resultId or {@code null} for none
   */
  public QualityDialogManagerLocalResult setResultId(NlpSemanticParsingLocalLocalResultId resultId) {
    this.resultId = resultId;
    return this;
  }

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

  /**
   * @param streetName streetName or {@code null} for none
   */
  public QualityDialogManagerLocalResult setStreetName(java.lang.String streetName) {
    this.streetName = streetName;
    return this;
  }

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

  /**
   * @param streetNumber streetNumber or {@code null} for none
   */
  public QualityDialogManagerLocalResult setStreetNumber(java.lang.String streetNumber) {
    this.streetNumber = streetNumber;
    return this;
  }

  /**
   * A list of text synonyms the user could use to refer to the result.
   * @return value or {@code null} for none
   */
  public java.util.List<java.lang.String> getSynonym() {
    return synonym;
  }

  /**
   * A list of text synonyms the user could use to refer to the result.
   * @param synonym synonym or {@code null} for none
   */
  public QualityDialogManagerLocalResult setSynonym(java.util.List<java.lang.String> synonym) {
    this.synonym = synonym;
    return this;
  }

  /**
   * The address of this result formatted for TTS output. This formatting removes acronyms like
   * 2-letter state codes as they cannot be spoken well.
   * @return value or {@code null} for none
   */
  public java.lang.String getTtsAddress() {
    return ttsAddress;
  }

  /**
   * The address of this result formatted for TTS output. This formatting removes acronyms like
   * 2-letter state codes as they cannot be spoken well.
   * @param ttsAddress ttsAddress or {@code null} for none
   */
  public QualityDialogManagerLocalResult setTtsAddress(java.lang.String ttsAddress) {
    this.ttsAddress = ttsAddress;
    return this;
  }

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

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

}
