com.google.api.services.dialogflow.v3.model.GoogleCloudDialogflowCxV3QueryInput Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-dialogflow Show documentation
The newest version!
/*
 * 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.v3.model;

/**
 * Represents the query input. It can contain one of: 1. A conversational query in the form of text.
 * 2. An intent query that specifies which intent to trigger. 3. Natural language speech audio to be
 * processed. 4. An event to be triggered. 5. DTMF digits to invoke an intent and fill in parameter
 * value. 6. The results of a tool executed by the client.
 *
 *  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:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class GoogleCloudDialogflowCxV3QueryInput extends com.google.api.client.json.GenericJson {

  /**
   * The natural language speech audio to be processed.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDialogflowCxV3AudioInput audio;

  /**
   * The DTMF event to be handled.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDialogflowCxV3DtmfInput dtmf;

  /**
   * The event to be triggered.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDialogflowCxV3EventInput event;

  /**
   * The intent to be triggered.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDialogflowCxV3IntentInput intent;

  /**
   * Required. The language of the input. See [Language
   * Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the
   * currently supported language codes. Note that queries in the same session do not necessarily
   * need to specify the same language.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String languageCode;

  /**
   * The natural language text to be processed.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDialogflowCxV3TextInput text;

  /**
   * The natural language speech audio to be processed.
   * @return value or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3AudioInput getAudio() {
    return audio;
  }

  /**
   * The natural language speech audio to be processed.
   * @param audio audio or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3QueryInput setAudio(GoogleCloudDialogflowCxV3AudioInput audio) {
    this.audio = audio;
    return this;
  }

  /**
   * The DTMF event to be handled.
   * @return value or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3DtmfInput getDtmf() {
    return dtmf;
  }

  /**
   * The DTMF event to be handled.
   * @param dtmf dtmf or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3QueryInput setDtmf(GoogleCloudDialogflowCxV3DtmfInput dtmf) {
    this.dtmf = dtmf;
    return this;
  }

  /**
   * The event to be triggered.
   * @return value or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3EventInput getEvent() {
    return event;
  }

  /**
   * The event to be triggered.
   * @param event event or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3QueryInput setEvent(GoogleCloudDialogflowCxV3EventInput event) {
    this.event = event;
    return this;
  }

  /**
   * The intent to be triggered.
   * @return value or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3IntentInput getIntent() {
    return intent;
  }

  /**
   * The intent to be triggered.
   * @param intent intent or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3QueryInput setIntent(GoogleCloudDialogflowCxV3IntentInput intent) {
    this.intent = intent;
    return this;
  }

  /**
   * Required. The language of the input. See [Language
   * Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the
   * currently supported language codes. Note that queries in the same session do not necessarily
   * need to specify the same language.
   * @return value or {@code null} for none
   */
  public java.lang.String getLanguageCode() {
    return languageCode;
  }

  /**
   * Required. The language of the input. See [Language
   * Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the
   * currently supported language codes. Note that queries in the same session do not necessarily
   * need to specify the same language.
   * @param languageCode languageCode or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3QueryInput setLanguageCode(java.lang.String languageCode) {
    this.languageCode = languageCode;
    return this;
  }

  /**
   * The natural language text to be processed.
   * @return value or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3TextInput getText() {
    return text;
  }

  /**
   * The natural language text to be processed.
   * @param text text or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3QueryInput setText(GoogleCloudDialogflowCxV3TextInput text) {
    this.text = text;
    return this;
  }

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

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

}