/*
 * 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.dialogflow.v3beta1.model;

/**
 * Represents the parameters of a conversational query.
 *
 * <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 Dialogflow 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 GoogleCloudDialogflowCxV3beta1QueryParameters extends com.google.api.client.json.GenericJson {

  /**
   * Configures whether sentiment analysis should be performed. If not provided, sentiment analysis
   * is not performed.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean analyzeQueryTextSentiment;

  /**
   * The unique identifier of the page to override the current page in the session. Format:
   * `projects//locations//agents//flows//pages/`. If `current_page` is specified, the previous
   * state of the session will be ignored by Dialogflow, including the previous page and the
   * previous session parameters. In most cases, current_page and parameters should be configured
   * together to direct a session to a specific state.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String currentPage;

  /**
   * Whether to disable webhook calls for this request.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean disableWebhook;

  /**
   * A list of flow versions to override for the request. Format:
   * `projects//locations//agents//flows//versions/`. If version 1 of flow X is included in this
   * list, the traffic of flow X will go through version 1 regardless of the version configuration
   * in the environment. Each flow can have at most one version specified in this list.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<java.lang.String> flowVersions;

  /**
   * The geo location of this conversational query.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleTypeLatLng geoLocation;

  /**
   * Additional parameters to be put into session parameters. To remove a parameter from the
   * session, clients should explicitly set the parameter value to null. You can reference the
   * session parameters in the agent with the following format: $session.params.parameter-id.
   * Depending on your protocol or client library language, this is a map, associative array, symbol
   * table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: *
   * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type
   * is a composite entity then use map, otherwise, depending on the parameter value type, it could
   * be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity
   * type is a composite entity then use map from composite entity property names to property
   * values, otherwise, use parameter value.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map<String, java.lang.Object> parameters;

  /**
   * This field can be used to pass custom data into the webhook associated with the agent.
   * Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may
   * provide additional information in the payload. In particular, for the Dialogflow Phone Gateway
   * integration, this field has the form: ``` { "telephony": { "caller_id": "+18558363987" } } ```
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map<String, java.lang.Object> payload;

  /**
   * Additional session entity types to replace or extend developer entity types with. The entity
   * synonyms apply to all languages and persist for the session of this query.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<GoogleCloudDialogflowCxV3beta1SessionEntityType> sessionEntityTypes;

  /**
   * The time zone of this conversational query from the [time zone database](https://www.iana.org
   * /time-zones), e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in
   * the agent is used.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String timeZone;

  /**
   * This field can be used to pass HTTP headers for a webhook call. These headers will be sent to
   * webhook along with the headers that have been configured through Dialogflow web console. The
   * headers defined within this field will overwrite the headers configured through Dialogflow
   * console if there is a conflict. Header names are case-insensitive. Google's specified headers
   * are not allowed. Including: "Host", "Content-Length", "Connection", "From", "User-Agent",
   * "Accept-Encoding", "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map<String, java.lang.String> webhookHeaders;

  /**
   * Configures whether sentiment analysis should be performed. If not provided, sentiment analysis
   * is not performed.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getAnalyzeQueryTextSentiment() {
    return analyzeQueryTextSentiment;
  }

  /**
   * Configures whether sentiment analysis should be performed. If not provided, sentiment analysis
   * is not performed.
   * @param analyzeQueryTextSentiment analyzeQueryTextSentiment or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1QueryParameters setAnalyzeQueryTextSentiment(java.lang.Boolean analyzeQueryTextSentiment) {
    this.analyzeQueryTextSentiment = analyzeQueryTextSentiment;
    return this;
  }

  /**
   * The unique identifier of the page to override the current page in the session. Format:
   * `projects//locations//agents//flows//pages/`. If `current_page` is specified, the previous
   * state of the session will be ignored by Dialogflow, including the previous page and the
   * previous session parameters. In most cases, current_page and parameters should be configured
   * together to direct a session to a specific state.
   * @return value or {@code null} for none
   */
  public java.lang.String getCurrentPage() {
    return currentPage;
  }

  /**
   * The unique identifier of the page to override the current page in the session. Format:
   * `projects//locations//agents//flows//pages/`. If `current_page` is specified, the previous
   * state of the session will be ignored by Dialogflow, including the previous page and the
   * previous session parameters. In most cases, current_page and parameters should be configured
   * together to direct a session to a specific state.
   * @param currentPage currentPage or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1QueryParameters setCurrentPage(java.lang.String currentPage) {
    this.currentPage = currentPage;
    return this;
  }

  /**
   * Whether to disable webhook calls for this request.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getDisableWebhook() {
    return disableWebhook;
  }

  /**
   * Whether to disable webhook calls for this request.
   * @param disableWebhook disableWebhook or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1QueryParameters setDisableWebhook(java.lang.Boolean disableWebhook) {
    this.disableWebhook = disableWebhook;
    return this;
  }

  /**
   * A list of flow versions to override for the request. Format:
   * `projects//locations//agents//flows//versions/`. If version 1 of flow X is included in this
   * list, the traffic of flow X will go through version 1 regardless of the version configuration
   * in the environment. Each flow can have at most one version specified in this list.
   * @return value or {@code null} for none
   */
  public java.util.List<java.lang.String> getFlowVersions() {
    return flowVersions;
  }

  /**
   * A list of flow versions to override for the request. Format:
   * `projects//locations//agents//flows//versions/`. If version 1 of flow X is included in this
   * list, the traffic of flow X will go through version 1 regardless of the version configuration
   * in the environment. Each flow can have at most one version specified in this list.
   * @param flowVersions flowVersions or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1QueryParameters setFlowVersions(java.util.List<java.lang.String> flowVersions) {
    this.flowVersions = flowVersions;
    return this;
  }

  /**
   * The geo location of this conversational query.
   * @return value or {@code null} for none
   */
  public GoogleTypeLatLng getGeoLocation() {
    return geoLocation;
  }

  /**
   * The geo location of this conversational query.
   * @param geoLocation geoLocation or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1QueryParameters setGeoLocation(GoogleTypeLatLng geoLocation) {
    this.geoLocation = geoLocation;
    return this;
  }

  /**
   * Additional parameters to be put into session parameters. To remove a parameter from the
   * session, clients should explicitly set the parameter value to null. You can reference the
   * session parameters in the agent with the following format: $session.params.parameter-id.
   * Depending on your protocol or client library language, this is a map, associative array, symbol
   * table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: *
   * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type
   * is a composite entity then use map, otherwise, depending on the parameter value type, it could
   * be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity
   * type is a composite entity then use map from composite entity property names to property
   * values, otherwise, use parameter value.
   * @return value or {@code null} for none
   */
  public java.util.Map<String, java.lang.Object> getParameters() {
    return parameters;
  }

  /**
   * Additional parameters to be put into session parameters. To remove a parameter from the
   * session, clients should explicitly set the parameter value to null. You can reference the
   * session parameters in the agent with the following format: $session.params.parameter-id.
   * Depending on your protocol or client library language, this is a map, associative array, symbol
   * table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: *
   * MapKey type: string * MapKey value: parameter name * MapValue type: If parameter's entity type
   * is a composite entity then use map, otherwise, depending on the parameter value type, it could
   * be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity
   * type is a composite entity then use map from composite entity property names to property
   * values, otherwise, use parameter value.
   * @param parameters parameters or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1QueryParameters setParameters(java.util.Map<String, java.lang.Object> parameters) {
    this.parameters = parameters;
    return this;
  }

  /**
   * This field can be used to pass custom data into the webhook associated with the agent.
   * Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may
   * provide additional information in the payload. In particular, for the Dialogflow Phone Gateway
   * integration, this field has the form: ``` { "telephony": { "caller_id": "+18558363987" } } ```
   * @return value or {@code null} for none
   */
  public java.util.Map<String, java.lang.Object> getPayload() {
    return payload;
  }

  /**
   * This field can be used to pass custom data into the webhook associated with the agent.
   * Arbitrary JSON objects are supported. Some integrations that query a Dialogflow agent may
   * provide additional information in the payload. In particular, for the Dialogflow Phone Gateway
   * integration, this field has the form: ``` { "telephony": { "caller_id": "+18558363987" } } ```
   * @param payload payload or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1QueryParameters setPayload(java.util.Map<String, java.lang.Object> payload) {
    this.payload = payload;
    return this;
  }

  /**
   * Additional session entity types to replace or extend developer entity types with. The entity
   * synonyms apply to all languages and persist for the session of this query.
   * @return value or {@code null} for none
   */
  public java.util.List<GoogleCloudDialogflowCxV3beta1SessionEntityType> getSessionEntityTypes() {
    return sessionEntityTypes;
  }

  /**
   * Additional session entity types to replace or extend developer entity types with. The entity
   * synonyms apply to all languages and persist for the session of this query.
   * @param sessionEntityTypes sessionEntityTypes or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1QueryParameters setSessionEntityTypes(java.util.List<GoogleCloudDialogflowCxV3beta1SessionEntityType> sessionEntityTypes) {
    this.sessionEntityTypes = sessionEntityTypes;
    return this;
  }

  /**
   * The time zone of this conversational query from the [time zone database](https://www.iana.org
   * /time-zones), e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in
   * the agent is used.
   * @return value or {@code null} for none
   */
  public java.lang.String getTimeZone() {
    return timeZone;
  }

  /**
   * The time zone of this conversational query from the [time zone database](https://www.iana.org
   * /time-zones), e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in
   * the agent is used.
   * @param timeZone timeZone or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1QueryParameters setTimeZone(java.lang.String timeZone) {
    this.timeZone = timeZone;
    return this;
  }

  /**
   * This field can be used to pass HTTP headers for a webhook call. These headers will be sent to
   * webhook along with the headers that have been configured through Dialogflow web console. The
   * headers defined within this field will overwrite the headers configured through Dialogflow
   * console if there is a conflict. Header names are case-insensitive. Google's specified headers
   * are not allowed. Including: "Host", "Content-Length", "Connection", "From", "User-Agent",
   * "Accept-Encoding", "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc.
   * @return value or {@code null} for none
   */
  public java.util.Map<String, java.lang.String> getWebhookHeaders() {
    return webhookHeaders;
  }

  /**
   * This field can be used to pass HTTP headers for a webhook call. These headers will be sent to
   * webhook along with the headers that have been configured through Dialogflow web console. The
   * headers defined within this field will overwrite the headers configured through Dialogflow
   * console if there is a conflict. Header names are case-insensitive. Google's specified headers
   * are not allowed. Including: "Host", "Content-Length", "Connection", "From", "User-Agent",
   * "Accept-Encoding", "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc.
   * @param webhookHeaders webhookHeaders or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1QueryParameters setWebhookHeaders(java.util.Map<String, java.lang.String> webhookHeaders) {
    this.webhookHeaders = webhookHeaders;
    return this;
  }

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

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

}
