com.google.cloud.dialogflow.cx.v3

Interface SessionInfoOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SessionInfo, SessionInfo.Builder

public interface SessionInfoOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsParameters(String key) Optional for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest].
Map<String,com.google.protobuf.Value>	getParameters() Deprecated.
int	getParametersCount() Optional for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest].
Map<String,com.google.protobuf.Value>	getParametersMap() Optional for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest].
com.google.protobuf.Value	getParametersOrDefault(String key, com.google.protobuf.Value defaultValue) Optional for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest].
com.google.protobuf.Value	getParametersOrThrow(String key) Optional for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest].
String	getSession() Always present for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest].
com.google.protobuf.ByteString	getSessionBytes() Always present for [WebhookRequest][google.cloud.dialogflow.cx.v3.WebhookRequest].

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getSession

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) = { ... }

Returns:

The session.

getSessionBytes

com.google.protobuf.ByteString getSessionBytes()

 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) = { ... }

Returns:

The bytes for session.

getParametersCount

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;

containsParameters

boolean containsParameters(String key)

 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;

getParameters

@Deprecated
Map<String,com.google.protobuf.Value> getParameters()

Deprecated.

Use getParametersMap() instead.

getParametersMap

Map<String,com.google.protobuf.Value> 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;

getParametersOrDefault

com.google.protobuf.Value getParametersOrDefault(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;

getParametersOrThrow

com.google.protobuf.Value getParametersOrThrow(String key)

 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;