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

/**
 * Response messages from an automated agent.
 *
 * <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 GoogleCloudDialogflowV2beta1ResponseMessage extends com.google.api.client.json.GenericJson {

  /**
   * A signal that indicates the interaction with the Dialogflow agent has ended.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction endInteraction;

  /**
   * Hands off conversation to a live agent.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff liveAgentHandoff;

  /**
   * An audio response message composed of both the synthesized Dialogflow agent responses and the
   * audios hosted in places known to the client.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio mixedAudio;

  /**
   * Returns a response containing a custom, platform-specific payload.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map<String, java.lang.Object> payload;

  /**
   * A signal that the client should transfer the phone call connected to this agent to a third-
   * party endpoint.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall telephonyTransferCall;

  /**
   * Returns a text response.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDialogflowV2beta1ResponseMessageText text;

  /**
   * A signal that indicates the interaction with the Dialogflow agent has ended.
   * @return value or {@code null} for none
   */
  public GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction getEndInteraction() {
    return endInteraction;
  }

  /**
   * A signal that indicates the interaction with the Dialogflow agent has ended.
   * @param endInteraction endInteraction or {@code null} for none
   */
  public GoogleCloudDialogflowV2beta1ResponseMessage setEndInteraction(GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction endInteraction) {
    this.endInteraction = endInteraction;
    return this;
  }

  /**
   * Hands off conversation to a live agent.
   * @return value or {@code null} for none
   */
  public GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff getLiveAgentHandoff() {
    return liveAgentHandoff;
  }

  /**
   * Hands off conversation to a live agent.
   * @param liveAgentHandoff liveAgentHandoff or {@code null} for none
   */
  public GoogleCloudDialogflowV2beta1ResponseMessage setLiveAgentHandoff(GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff liveAgentHandoff) {
    this.liveAgentHandoff = liveAgentHandoff;
    return this;
  }

  /**
   * An audio response message composed of both the synthesized Dialogflow agent responses and the
   * audios hosted in places known to the client.
   * @return value or {@code null} for none
   */
  public GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio getMixedAudio() {
    return mixedAudio;
  }

  /**
   * An audio response message composed of both the synthesized Dialogflow agent responses and the
   * audios hosted in places known to the client.
   * @param mixedAudio mixedAudio or {@code null} for none
   */
  public GoogleCloudDialogflowV2beta1ResponseMessage setMixedAudio(GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio mixedAudio) {
    this.mixedAudio = mixedAudio;
    return this;
  }

  /**
   * Returns a response containing a custom, platform-specific payload.
   * @return value or {@code null} for none
   */
  public java.util.Map<String, java.lang.Object> getPayload() {
    return payload;
  }

  /**
   * Returns a response containing a custom, platform-specific payload.
   * @param payload payload or {@code null} for none
   */
  public GoogleCloudDialogflowV2beta1ResponseMessage setPayload(java.util.Map<String, java.lang.Object> payload) {
    this.payload = payload;
    return this;
  }

  /**
   * A signal that the client should transfer the phone call connected to this agent to a third-
   * party endpoint.
   * @return value or {@code null} for none
   */
  public GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall getTelephonyTransferCall() {
    return telephonyTransferCall;
  }

  /**
   * A signal that the client should transfer the phone call connected to this agent to a third-
   * party endpoint.
   * @param telephonyTransferCall telephonyTransferCall or {@code null} for none
   */
  public GoogleCloudDialogflowV2beta1ResponseMessage setTelephonyTransferCall(GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall telephonyTransferCall) {
    this.telephonyTransferCall = telephonyTransferCall;
    return this;
  }

  /**
   * Returns a text response.
   * @return value or {@code null} for none
   */
  public GoogleCloudDialogflowV2beta1ResponseMessageText getText() {
    return text;
  }

  /**
   * Returns a text response.
   * @param text text or {@code null} for none
   */
  public GoogleCloudDialogflowV2beta1ResponseMessage setText(GoogleCloudDialogflowV2beta1ResponseMessageText text) {
    this.text = text;
    return this;
  }

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

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

}
