Package com.google.cloud.dialogflow.v2

Interface ContextOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Context, Context.Builder
    public interface ContextOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getLifespanCount()
      Optional.
      String getName()
      Required.
      com.google.protobuf.ByteString getNameBytes()
      Required.
      com.google.protobuf.Struct getParameters()
      Optional.
      com.google.protobuf.StructOrBuilder getParametersOrBuilder()
      Optional.
      boolean hasParameters()
      Optional.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • getName

        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];
        Returns:
        The name.

      • getNameBytes

        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];
        Returns:
        The bytes for name.

      • getLifespanCount

        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];
        Returns:
        The lifespanCount.

      • hasParameters

        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];
        Returns:
        Whether the parameters field is set.

      • getParameters

        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];
        Returns:
        The parameters.

      • getParametersOrBuilder

        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];