Package com.google.cloud.dialogflow.v2

Class Context.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Context.Builder>
com.google.cloud.dialogflow.v2.Context.Builder
All Implemented Interfaces:
ContextOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Context
public static final class Context.Builder extends com.google.protobuf.GeneratedMessage.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](https://cloud.google.com/dialogflow/docs/contexts-overview).
Protobuf type google.cloud.dialogflow.v2.Context

  • Method Summary

    Modifier and Type
    Method
    Description
    Context
    build()
     
    Context
    buildPartial()
     
    Context.Builder
    clear()
     
    Context.Builder
    clearLifespanCount()
    Optional.
    Context.Builder
    clearName()
    Required.
    Context.Builder
    clearParameters()
    Optional.
    Context
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    int
    getLifespanCount()
    Optional.
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.
    com.google.protobuf.Struct
    getParameters()
    Optional.
    com.google.protobuf.Struct.Builder
    getParametersBuilder()
    Optional.
    com.google.protobuf.StructOrBuilder
    getParametersOrBuilder()
    Optional.
    boolean
    hasParameters()
    Optional.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    Context.Builder
    mergeFrom(Context other)
     
    Context.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    Context.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    Context.Builder
    mergeParameters(com.google.protobuf.Struct value)
    Optional.
    Context.Builder
    setLifespanCount(int value)
    Optional.
    Context.Builder
    setName(String value)
    Required.
    Context.Builder
    setNameBytes(com.google.protobuf.ByteString value)
    Required.
    Context.Builder
    setParameters(com.google.protobuf.Struct value)
    Optional.
    Context.Builder
    setParameters(com.google.protobuf.Struct.Builder builderForValue)
    Optional.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Context.Builder>

    • clear

      public Context.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Context.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Context.Builder>

    • getDefaultInstanceForType

      public Context getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public Context build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public Context buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public Context.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Context.Builder>

    • mergeFrom

      public Context.Builder mergeFrom(Context other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Context.Builder>

    • mergeFrom

      public Context.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Context.Builder>
      Throws:
      IOException

    • getName

      public String getName()
       Required. The unique identifier of the context. Format:
 `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
 or `projects/<Project 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 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getName in interface ContextOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Required. The unique identifier of the context. Format:
 `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
 or `projects/<Project 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 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getNameBytes in interface ContextOrBuilder
      Returns:
      The bytes for name.

    • setName

      public Context.Builder setName(String value)
       Required. The unique identifier of the context. Format:
 `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
 or `projects/<Project 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 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public Context.Builder clearName()
       Required. The unique identifier of the context. Format:
 `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
 or `projects/<Project 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 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setNameBytes

      public Context.Builder setNameBytes(com.google.protobuf.ByteString value)
       Required. The unique identifier of the context. Format:
 `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`,
 or `projects/<Project 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 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLifespanCount in interface ContextOrBuilder
      Returns:
      The lifespanCount.

    • setLifespanCount

      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 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The lifespanCount to set.
      Returns:
      This builder for chaining.

    • 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 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasParameters in interface ContextOrBuilder
      Returns:
      Whether the parameters field is set.

    • getParameters

      public com.google.protobuf.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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getParameters in interface ContextOrBuilder
      Returns:
      The parameters.

    • setParameters

      public Context.Builder setParameters(com.google.protobuf.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 [(.google.api.field_behavior) = OPTIONAL];

    • setParameters

      public Context.Builder setParameters(com.google.protobuf.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 [(.google.api.field_behavior) = OPTIONAL];

    • mergeParameters

      public Context.Builder mergeParameters(com.google.protobuf.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 [(.google.api.field_behavior) = OPTIONAL];

    • 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 [(.google.api.field_behavior) = OPTIONAL];

    • getParametersBuilder

      public com.google.protobuf.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 [(.google.api.field_behavior) = OPTIONAL];

    • getParametersOrBuilder

      public com.google.protobuf.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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getParametersOrBuilder in interface ContextOrBuilder