com.google.api.services.dialogflow.v3.model.GoogleCloudDialogflowCxV3beta1WebhookResponse 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 response message for a webhook call.
 *
 *  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 GoogleCloudDialogflowCxV3beta1WebhookResponse extends com.google.api.client.json.GenericJson {

  /**
   * The fulfillment response to send to the user. This field can be omitted by the webhook if it
   * does not intend to send any response to the user.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse fulfillmentResponse;

  /**
   * Information about page status. This field can be omitted by the webhook if it does not intend
   * to modify page status.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDialogflowCxV3beta1PageInfo pageInfo;

  /**
   * Value to append directly to QueryResult.webhook_payloads.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map payload;

  /**
   * Information about session status. This field can be omitted by the webhook if it does not
   * intend to modify session status.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudDialogflowCxV3beta1SessionInfo sessionInfo;

  /**
   * The target flow to transition to. Format: `projects//locations//agents//flows/`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String targetFlow;

  /**
   * The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String targetPage;

  /**
   * The fulfillment response to send to the user. This field can be omitted by the webhook if it
   * does not intend to send any response to the user.
   * @return value or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse getFulfillmentResponse() {
    return fulfillmentResponse;
  }

  /**
   * The fulfillment response to send to the user. This field can be omitted by the webhook if it
   * does not intend to send any response to the user.
   * @param fulfillmentResponse fulfillmentResponse or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1WebhookResponse setFulfillmentResponse(GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse fulfillmentResponse) {
    this.fulfillmentResponse = fulfillmentResponse;
    return this;
  }

  /**
   * Information about page status. This field can be omitted by the webhook if it does not intend
   * to modify page status.
   * @return value or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1PageInfo getPageInfo() {
    return pageInfo;
  }

  /**
   * Information about page status. This field can be omitted by the webhook if it does not intend
   * to modify page status.
   * @param pageInfo pageInfo or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1WebhookResponse setPageInfo(GoogleCloudDialogflowCxV3beta1PageInfo pageInfo) {
    this.pageInfo = pageInfo;
    return this;
  }

  /**
   * Value to append directly to QueryResult.webhook_payloads.
   * @return value or {@code null} for none
   */
  public java.util.Map getPayload() {
    return payload;
  }

  /**
   * Value to append directly to QueryResult.webhook_payloads.
   * @param payload payload or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1WebhookResponse setPayload(java.util.Map payload) {
    this.payload = payload;
    return this;
  }

  /**
   * Information about session status. This field can be omitted by the webhook if it does not
   * intend to modify session status.
   * @return value or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1SessionInfo getSessionInfo() {
    return sessionInfo;
  }

  /**
   * Information about session status. This field can be omitted by the webhook if it does not
   * intend to modify session status.
   * @param sessionInfo sessionInfo or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1WebhookResponse setSessionInfo(GoogleCloudDialogflowCxV3beta1SessionInfo sessionInfo) {
    this.sessionInfo = sessionInfo;
    return this;
  }

  /**
   * The target flow to transition to. Format: `projects//locations//agents//flows/`.
   * @return value or {@code null} for none
   */
  public java.lang.String getTargetFlow() {
    return targetFlow;
  }

  /**
   * The target flow to transition to. Format: `projects//locations//agents//flows/`.
   * @param targetFlow targetFlow or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1WebhookResponse setTargetFlow(java.lang.String targetFlow) {
    this.targetFlow = targetFlow;
    return this;
  }

  /**
   * The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
   * @return value or {@code null} for none
   */
  public java.lang.String getTargetPage() {
    return targetPage;
  }

  /**
   * The target page to transition to. Format: `projects//locations//agents//flows//pages/`.
   * @param targetPage targetPage or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3beta1WebhookResponse setTargetPage(java.lang.String targetPage) {
    this.targetPage = targetPage;
    return this;
  }

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

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

}