Class Context.Builder (4.59.0) 

public static final class Context.Builder extends GeneratedMessageV3.Builder<Context.Builder> implements ContextOrBuilder

Dialogflow contexts are similar to natural language context. If a person says to you "they are orange", you need context in order to understand what "they" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent.

Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts.

For more information about context, see the Contexts guide.

Protobuf type google.cloud.dialogflow.v2beta1.Context

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Context.Builder

Implements

ContextOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Context.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Context.Builder
Overrides

build()

public Context build()
Returns
Type Description
Context

buildPartial()

public Context buildPartial()
Returns
Type Description
Context

clear()

public Context.Builder clear()
Returns
Type Description
Context.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Context.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Context.Builder
Overrides

clearLifespanCount()

public Context.Builder clearLifespanCount()

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
Context.Builder

This builder for chaining.

clearName()

public Context.Builder clearName()

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>,

    The Context ID is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

    If Environment ID is not specified, we assume default 'draft' environment. If User 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
Context.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Context.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Context.Builder
Overrides

clearParameters()

public Context.Builder clearParameters()

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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

.google.protobuf.Struct parameters = 3;

Returns
Type Description
Context.Builder

clone()

public Context.Builder clone()
Returns
Type Description
Context.Builder
Overrides

getDefaultInstanceForType()

public Context getDefaultInstanceForType()
Returns
Type Description
Context

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getLifespanCount()

public 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 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>,

    The Context ID is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

    If Environment ID is not specified, we assume default 'draft' environment. If User 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 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>,

    The Context ID is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

    If Environment ID is not specified, we assume default 'draft' environment. If User 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 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

.google.protobuf.Struct parameters = 3;

Returns
Type Description
Struct

The parameters.

getParametersBuilder()

public Struct.Builder getParametersBuilder()

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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

.google.protobuf.Struct parameters = 3;

Returns
Type Description
Builder

getParametersOrBuilder()

public 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

.google.protobuf.Struct parameters = 3;

Returns
Type Description
StructOrBuilder

hasParameters()

public 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

.google.protobuf.Struct parameters = 3;

Returns
Type Description
boolean

Whether the parameters field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Context other)

public Context.Builder mergeFrom(Context other)
Parameter
Name Description
other Context
Returns
Type Description
Context.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Context.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Context.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Context.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Context.Builder
Overrides

mergeParameters(Struct value)

public Context.Builder mergeParameters(Struct value)

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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

.google.protobuf.Struct parameters = 3;

Parameter
Name Description
value Struct
Returns
Type Description
Context.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Context.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Context.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public Context.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Context.Builder
Overrides

setLifespanCount(int value)

public Context.Builder setLifespanCount(int value)

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;

Parameter
Name Description
value int

The lifespanCount to set.
Returns
Type Description
Context.Builder

This builder for chaining.

setName(String value)

public Context.Builder setName(String value)

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>,

    The Context ID is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

    If Environment ID is not specified, we assume default 'draft' environment. If User 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;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Context.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Context.Builder setNameBytes(ByteString value)

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>,

    The Context ID is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long.

    If Environment ID is not specified, we assume default 'draft' environment. If User 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;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Context.Builder

This builder for chaining.

setParameters(Struct value)

public Context.Builder setParameters(Struct value)

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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

.google.protobuf.Struct parameters = 3;

Parameter
Name Description
value Struct
Returns
Type Description
Context.Builder

setParameters(Struct.Builder builderForValue)

public Context.Builder setParameters(Struct.Builder builderForValue)

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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
  • MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

.google.protobuf.Struct parameters = 3;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Context.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Context.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Context.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Context.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Context.Builder
Overrides