com.google.api.services.dialogflow.v3.model.GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettings 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;

/**
 * Define behaviors for DTMF (dual tone multi frequency).
 *
 *  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 GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettings extends com.google.api.client.json.GenericJson {

  /**
   * If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example,
   * if the caller presses a button on their telephone keypad and DTMF processing is enabled,
   * Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the
   * event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean enabled;

  /**
   * Endpoint timeout setting for matching dtmf input to regex.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String endpointingTimeoutDuration;

  /**
   * The digit that terminates a DTMF digit sequence.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String finishDigit;

  /**
   * Interdigit timeout setting for matching dtmf input to regex.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String interdigitTimeoutDuration;

  /**
   * Max length of DTMF digits.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer maxDigits;

  /**
   * If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example,
   * if the caller presses a button on their telephone keypad and DTMF processing is enabled,
   * Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the
   * event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getEnabled() {
    return enabled;
  }

  /**
   * If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example,
   * if the caller presses a button on their telephone keypad and DTMF processing is enabled,
   * Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the
   * event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
   * @param enabled enabled or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettings setEnabled(java.lang.Boolean enabled) {
    this.enabled = enabled;
    return this;
  }

  /**
   * Endpoint timeout setting for matching dtmf input to regex.
   * @return value or {@code null} for none
   */
  public String getEndpointingTimeoutDuration() {
    return endpointingTimeoutDuration;
  }

  /**
   * Endpoint timeout setting for matching dtmf input to regex.
   * @param endpointingTimeoutDuration endpointingTimeoutDuration or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettings setEndpointingTimeoutDuration(String endpointingTimeoutDuration) {
    this.endpointingTimeoutDuration = endpointingTimeoutDuration;
    return this;
  }

  /**
   * The digit that terminates a DTMF digit sequence.
   * @return value or {@code null} for none
   */
  public java.lang.String getFinishDigit() {
    return finishDigit;
  }

  /**
   * The digit that terminates a DTMF digit sequence.
   * @param finishDigit finishDigit or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettings setFinishDigit(java.lang.String finishDigit) {
    this.finishDigit = finishDigit;
    return this;
  }

  /**
   * Interdigit timeout setting for matching dtmf input to regex.
   * @return value or {@code null} for none
   */
  public String getInterdigitTimeoutDuration() {
    return interdigitTimeoutDuration;
  }

  /**
   * Interdigit timeout setting for matching dtmf input to regex.
   * @param interdigitTimeoutDuration interdigitTimeoutDuration or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettings setInterdigitTimeoutDuration(String interdigitTimeoutDuration) {
    this.interdigitTimeoutDuration = interdigitTimeoutDuration;
    return this;
  }

  /**
   * Max length of DTMF digits.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getMaxDigits() {
    return maxDigits;
  }

  /**
   * Max length of DTMF digits.
   * @param maxDigits maxDigits or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1AdvancedSettingsDtmfSettings setMaxDigits(java.lang.Integer maxDigits) {
    this.maxDigits = maxDigits;
    return this;
  }

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

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

}