public static final class SessionInfo.Builder extends GeneratedMessage.Builder<SessionInfo.Builder> implements SessionInfoOrBuilder
Represents session information communicated to and from the webhook.
Protobuf type google.cloud.dialogflow.cx.v3.SessionInfo
Inherited Members
com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
build()
public SessionInfo build()
buildPartial()
public SessionInfo buildPartial()
clear()
public SessionInfo.Builder clear()
Overrides
clearParameters()
public SessionInfo.Builder clearParameters()
clearSession()
public SessionInfo.Builder clearSession()
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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>
or
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>
if environment is specified.
string session = 1 [(.google.api.resource_reference) = { ... }
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
|
getDefaultInstanceForType()
public SessionInfo getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getMutableParameters() (deprecated)
public Map<String,Value> getMutableParameters()
Use alternate mutation accessors instead.
getParameters() (deprecated)
public Map<String,Value> getParameters()
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;
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 |
|
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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>
or
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>
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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>
or
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>
if environment is specified.
string session = 1 [(.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for session.
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
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.GeneratedMessage.Builder.internalGetMapFieldReflection(int)
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(SessionInfo other)
public SessionInfo.Builder mergeFrom(SessionInfo other)
public SessionInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public SessionInfo.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
putAllParameters(Map<String,Value> values)
public SessionInfo.Builder putAllParameters(Map<String,Value> values)
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;
putParameters(String key, Value value)
public SessionInfo.Builder putParameters(String key, Value value)
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;
putParametersBuilderIfAbsent(String key)
public Value.Builder putParametersBuilderIfAbsent(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
|
removeParameters(String key)
public SessionInfo.Builder removeParameters(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
|
setSession(String value)
public SessionInfo.Builder setSession(String value)
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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>
or
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>
if environment is specified.
string session = 1 [(.google.api.resource_reference) = { ... }
| Parameter |
| Name |
Description |
value |
String
The session to set.
|
setSessionBytes(ByteString value)
public SessionInfo.Builder setSessionBytes(ByteString value)
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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>
or
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>
if environment is specified.
string session = 1 [(.google.api.resource_reference) = { ... }
| Parameter |
| Name |
Description |
value |
ByteString
The bytes for session to set.
|
