com.google.cloud.dialogflow.cx.v3.SessionInfoOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-dialogflow-cx-v3 Show documentation
PROTO library for proto-google-cloud-dialogflow-cx-v3
There is a newer version: 0.66.0
Show newest version
/*
 * Copyright 2020 Google LLC
 *
 * 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
 *
 *     https://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.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/dialogflow/cx/v3/webhook.proto

package com.google.cloud.dialogflow.cx.v3;

public interface SessionInfoOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.cx.v3.SessionInfo)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Always present for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Ignored for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse].
   * The unique identifier of the [session][google.cloud.dialogflow.cx.v3.DetectIntentRequest.session]. This
   * field can be used by the webhook to identify a session.
   * Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
   * ID>/sessions/<Session ID>` or `projects/<Project ID>/locations/<Location
   * ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>`
   * if environment is specified.
   * 
   *
   * string session = 1 [(.google.api.resource_reference) = { ... }
   *
   * @return The session.
   */
  java.lang.String getSession();
  /**
   *
   *
   *    * Always present for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Ignored for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse].
   * The unique identifier of the [session][google.cloud.dialogflow.cx.v3.DetectIntentRequest.session]. This
   * field can be used by the webhook to identify a session.
   * Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
   * ID>/sessions/<Session ID>` or `projects/<Project ID>/locations/<Location
   * ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>`
   * if environment is specified.
   * 
   *
   * string session = 1 [(.google.api.resource_reference) = { ... }
   *
   * @return The bytes for session.
   */
  com.google.protobuf.ByteString getSessionBytes();

  /**
   *
   *
   *    * Optional for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Optional for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse].
   * All parameters collected from forms and intents during the session.
   * Parameters can be created, updated, or removed by the webhook. To remove a
   * parameter from the session, the webhook should explicitly set the parameter
   * value to null in [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The map is keyed by parameters'
   * display names.
   * 
   *
   * map<string, .google.protobuf.Value> parameters = 2;
   */
  int getParametersCount();
  /**
   *
   *
   *    * Optional for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Optional for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse].
   * All parameters collected from forms and intents during the session.
   * Parameters can be created, updated, or removed by the webhook. To remove a
   * parameter from the session, the webhook should explicitly set the parameter
   * value to null in [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The map is keyed by parameters'
   * display names.
   * 
   *
   * map<string, .google.protobuf.Value> parameters = 2;
   */
  boolean containsParameters(java.lang.String key);
  /** Use {@link #getParametersMap()} instead. */
  @java.lang.Deprecated
  java.util.Map getParameters();
  /**
   *
   *
   *    * Optional for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Optional for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse].
   * All parameters collected from forms and intents during the session.
   * Parameters can be created, updated, or removed by the webhook. To remove a
   * parameter from the session, the webhook should explicitly set the parameter
   * value to null in [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The map is keyed by parameters'
   * display names.
   * 
   *
   * map<string, .google.protobuf.Value> parameters = 2;
   */
  java.util.Map getParametersMap();
  /**
   *
   *
   *    * Optional for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Optional for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse].
   * All parameters collected from forms and intents during the session.
   * Parameters can be created, updated, or removed by the webhook. To remove a
   * parameter from the session, the webhook should explicitly set the parameter
   * value to null in [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The map is keyed by parameters'
   * display names.
   * 
   *
   * map<string, .google.protobuf.Value> parameters = 2;
   */
  com.google.protobuf.Value getParametersOrDefault(
      java.lang.String key, com.google.protobuf.Value defaultValue);
  /**
   *
   *
   *    * Optional for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest]. Optional for [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse].
   * All parameters collected from forms and intents during the session.
   * Parameters can be created, updated, or removed by the webhook. To remove a
   * parameter from the session, the webhook should explicitly set the parameter
   * value to null in [WebhookResponse][google.cloud.dialogflow.cx.v3.WebhookResponse]. The map is keyed by parameters'
   * display names.
   * 
   *
   * map<string, .google.protobuf.Value> parameters = 2;
   */
  com.google.protobuf.Value getParametersOrThrow(java.lang.String key);
}