Class SessionInfo (0.54.0)

public final class SessionInfo extends GeneratedMessageV3 implements SessionInfoOrBuilder

Represents session information communicated to and from the webhook.

Protobuf type google.cloud.dialogflow.cx.v3.SessionInfo

Static Fields

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

SESSION_FIELD_NUMBER

public static final int SESSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SessionInfo getDefaultInstance()
Returns
Type Description
SessionInfo

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SessionInfo.Builder newBuilder()
Returns
Type Description
SessionInfo.Builder

newBuilder(SessionInfo prototype)

public static SessionInfo.Builder newBuilder(SessionInfo prototype)
Parameter
Name Description
prototype SessionInfo
Returns
Type Description
SessionInfo.Builder

parseDelimitedFrom(InputStream input)

public static SessionInfo parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SessionInfo
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SessionInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionInfo
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SessionInfo parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SessionInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SessionInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SessionInfo parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SessionInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SessionInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SessionInfo parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SessionInfo
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SessionInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SessionInfo parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SessionInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SessionInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionInfo
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SessionInfo parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SessionInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SessionInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SessionInfo
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SessionInfo> parser()
Returns
Type Description
Parser<SessionInfo>

Methods

containsParameters(String key)

public boolean containsParameters(String key)

Optional for WebhookRequest. Optional for 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. The map is keyed by parameters' display names.

map<string, .google.protobuf.Value> parameters = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SessionInfo getDefaultInstanceForType()
Returns
Type Description
SessionInfo

getParameters() (deprecated)

public Map<String,Value> getParameters()

Use #getParametersMap() instead.

Returns
Type Description
Map<String,Value>

getParametersCount()

public int getParametersCount()

Optional for WebhookRequest. Optional for 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. The map is keyed by parameters' display names.

map<string, .google.protobuf.Value> parameters = 2;

Returns
Type Description
int

getParametersMap()

public Map<String,Value> getParametersMap()

Optional for WebhookRequest. Optional for 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. The map is keyed by parameters' display names.

map<string, .google.protobuf.Value> parameters = 2;

Returns
Type Description
Map<String,Value>

getParametersOrDefault(String key, Value defaultValue)

public Value getParametersOrDefault(String key, Value defaultValue)

Optional for WebhookRequest. Optional for 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. The map is keyed by parameters' display names.

map<string, .google.protobuf.Value> parameters = 2;

Parameters
Name Description
key String
defaultValue Value
Returns
Type Description
Value

getParametersOrThrow(String key)

public Value getParametersOrThrow(String key)

Optional for WebhookRequest. Optional for 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. The map is keyed by parameters' display names.

map<string, .google.protobuf.Value> parameters = 2;

Parameter
Name Description
key String
Returns
Type Description
Value

getParserForType()

public Parser<SessionInfo> getParserForType()
Returns
Type Description
Parser<SessionInfo>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSession()

public String getSession()

Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the 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
Type Description
String

The session.

getSessionBytes()

public ByteString getSessionBytes()

Always present for WebhookRequest. Ignored for WebhookResponse. The unique identifier of the 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
Type Description
ByteString

The bytes for session.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SessionInfo.Builder newBuilderForType()
Returns
Type Description
SessionInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SessionInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SessionInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SessionInfo.Builder toBuilder()
Returns
Type Description
SessionInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException