public interface ContextOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getLifespanCount()
public abstract int getLifespanCount()
Optional. The number of conversational query requests after which the
context expires. The default is 0
. If set to 0
, the context expires
immediately. Contexts expire automatically after 20 minutes if there
are no matching queries.
int32 lifespan_count = 2;
Returns | |
---|---|
Type | Description |
int | The lifespanCount. |
getName()
public abstract String getName()
Required. The unique identifier of the context. Supported formats:
projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>
,projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>/contexts/<Context ID>
,projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>
,projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>
, TheContext ID
is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. IfEnvironment ID
is not specified, we assume default 'draft' environment. IfUser ID
is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names:system_counters
*_id_dialog_context
*_dialog_params_size
string name = 1;
Returns | |
---|---|
Type | Description |
String | The name. |
getNameBytes()
public abstract ByteString getNameBytes()
Required. The unique identifier of the context. Supported formats:
projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>
,projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>/contexts/<Context ID>
,projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>
,projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>
, TheContext ID
is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. IfEnvironment ID
is not specified, we assume default 'draft' environment. IfUser ID
is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names:system_counters
*_id_dialog_context
*_dialog_params_size
string name = 1;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for name. |
getParameters()
public abstract Struct getParameters()
Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:
- MapKey type: string
- MapKey value: parameter name
- MapValue type:
- If parameter's entity type is a composite entity: map
- Else: depending on parameter value type, could be one of string, number, boolean, null, list or map
- MapValue value:
- If parameter's entity type is a composite entity: map from composite entity property names to property values
- Else: parameter value
.google.protobuf.Struct parameters = 3;
Returns | |
---|---|
Type | Description |
Struct | The parameters. |
getParametersOrBuilder()
public abstract StructOrBuilder getParametersOrBuilder()
Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:
- MapKey type: string
- MapKey value: parameter name
- MapValue type:
- If parameter's entity type is a composite entity: map
- Else: depending on parameter value type, could be one of string, number, boolean, null, list or map
- MapValue value:
- If parameter's entity type is a composite entity: map from composite entity property names to property values
- Else: parameter value
.google.protobuf.Struct parameters = 3;
Returns | |
---|---|
Type | Description |
StructOrBuilder |
hasParameters()
public abstract boolean hasParameters()
Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:
- MapKey type: string
- MapKey value: parameter name
- MapValue type:
- If parameter's entity type is a composite entity: map
- Else: depending on parameter value type, could be one of string, number, boolean, null, list or map
- MapValue value:
- If parameter's entity type is a composite entity: map from composite entity property names to property values
- Else: parameter value
.google.protobuf.Struct parameters = 3;
Returns | |
---|---|
Type | Description |
boolean | Whether the parameters field is set. |