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

/**
 * The output from the virtual agent.
 *
 *  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 GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput extends com.google.api.client.json.GenericJson {

  /**
   * The Page on which the utterance was spoken. Only name and displayName will be set.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDialogflowCxV3beta1Page currentPage;

  /**
   * Required. Input only. The diagnostic info output for the turn. Required to calculate the
   * testing coverage.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map diagnosticInfo;

  /**
   * Output only. If this is part of a result conversation turn, the list of differences between the
   * original run and the replay for this output, if any.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List differences;

  /**
   * The session parameters available to the bot at this point.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map sessionParameters;

  /**
   * Response error from the agent in the test result. If set, other output is empty.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleRpcStatus status;

  /**
   * The text responses from the agent for the turn.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List textResponses;

  /**
   * The Intent that triggered the response. Only name and displayName will be set.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDialogflowCxV3beta1Intent triggeredIntent;

  /**
   * The Page on which the utterance was spoken. Only name and displayName will be set.
   * @return value or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1Page getCurrentPage() {
    return currentPage;
  }

  /**
   * The Page on which the utterance was spoken. Only name and displayName will be set.
   * @param currentPage currentPage or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput setCurrentPage(GoogleCloudDialogflowCxV3beta1Page currentPage) {
    this.currentPage = currentPage;
    return this;
  }

  /**
   * Required. Input only. The diagnostic info output for the turn. Required to calculate the
   * testing coverage.
   * @return value or {@code null} for none
   */
  public java.util.Map getDiagnosticInfo() {
    return diagnosticInfo;
  }

  /**
   * Required. Input only. The diagnostic info output for the turn. Required to calculate the
   * testing coverage.
   * @param diagnosticInfo diagnosticInfo or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput setDiagnosticInfo(java.util.Map diagnosticInfo) {
    this.diagnosticInfo = diagnosticInfo;
    return this;
  }

  /**
   * Output only. If this is part of a result conversation turn, the list of differences between the
   * original run and the replay for this output, if any.
   * @return value or {@code null} for none
   */
  public java.util.List getDifferences() {
    return differences;
  }

  /**
   * Output only. If this is part of a result conversation turn, the list of differences between the
   * original run and the replay for this output, if any.
   * @param differences differences or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput setDifferences(java.util.List differences) {
    this.differences = differences;
    return this;
  }

  /**
   * The session parameters available to the bot at this point.
   * @return value or {@code null} for none
   */
  public java.util.Map getSessionParameters() {
    return sessionParameters;
  }

  /**
   * The session parameters available to the bot at this point.
   * @param sessionParameters sessionParameters or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput setSessionParameters(java.util.Map sessionParameters) {
    this.sessionParameters = sessionParameters;
    return this;
  }

  /**
   * Response error from the agent in the test result. If set, other output is empty.
   * @return value or {@code null} for none
   */
  public GoogleRpcStatus getStatus() {
    return status;
  }

  /**
   * Response error from the agent in the test result. If set, other output is empty.
   * @param status status or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput setStatus(GoogleRpcStatus status) {
    this.status = status;
    return this;
  }

  /**
   * The text responses from the agent for the turn.
   * @return value or {@code null} for none
   */
  public java.util.List getTextResponses() {
    return textResponses;
  }

  /**
   * The text responses from the agent for the turn.
   * @param textResponses textResponses or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput setTextResponses(java.util.List textResponses) {
    this.textResponses = textResponses;
    return this;
  }

  /**
   * The Intent that triggered the response. Only name and displayName will be set.
   * @return value or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1Intent getTriggeredIntent() {
    return triggeredIntent;
  }

  /**
   * The Intent that triggered the response. Only name and displayName will be set.
   * @param triggeredIntent triggeredIntent or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1ConversationTurnVirtualAgentOutput setTriggeredIntent(GoogleCloudDialogflowCxV3beta1Intent triggeredIntent) {
    this.triggeredIntent = triggeredIntent;
    return this;
  }

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

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

}