Package com.google.cloud.dialogflow.cx.v3beta1

Class QueryParameters.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<QueryParameters.Builder>
com.google.cloud.dialogflow.cx.v3beta1.QueryParameters.Builder
All Implemented Interfaces:
QueryParametersOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
QueryParameters
public static final class QueryParameters.Builder extends com.google.protobuf.GeneratedMessage.Builder<QueryParameters.Builder> implements QueryParametersOrBuilder
 Represents the parameters of a conversational query.
Protobuf type google.cloud.dialogflow.cx.v3beta1.QueryParameters

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<QueryParameters.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<QueryParameters.Builder>

    • internalGetFieldAccessorTable

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

    • clear

      public QueryParameters.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<QueryParameters.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<QueryParameters.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public QueryParameters.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<QueryParameters.Builder>

    • mergeFrom

      public QueryParameters.Builder mergeFrom(QueryParameters other)

    • isInitialized

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

    • mergeFrom

      public QueryParameters.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<QueryParameters.Builder>
      Throws:
      IOException

    • getTimeZone

      public String getTimeZone()
       The time zone of this conversational query from the [time zone
 database](https://www.iana.org/time-zones), e.g., America/New_York,
 Europe/Paris. If not provided, the time zone specified in the agent is
 used.
      string time_zone = 1;
      Specified by:
      getTimeZone in interface QueryParametersOrBuilder
      Returns:
      The timeZone.

    • getTimeZoneBytes

      public com.google.protobuf.ByteString getTimeZoneBytes()
       The time zone of this conversational query from the [time zone
 database](https://www.iana.org/time-zones), e.g., America/New_York,
 Europe/Paris. If not provided, the time zone specified in the agent is
 used.
      string time_zone = 1;
      Specified by:
      getTimeZoneBytes in interface QueryParametersOrBuilder
      Returns:
      The bytes for timeZone.

    • setTimeZone

      public QueryParameters.Builder setTimeZone(String value)
       The time zone of this conversational query from the [time zone
 database](https://www.iana.org/time-zones), e.g., America/New_York,
 Europe/Paris. If not provided, the time zone specified in the agent is
 used.
      string time_zone = 1;
      Parameters:
      value - The timeZone to set.
      Returns:
      This builder for chaining.

    • clearTimeZone

      public QueryParameters.Builder clearTimeZone()
       The time zone of this conversational query from the [time zone
 database](https://www.iana.org/time-zones), e.g., America/New_York,
 Europe/Paris. If not provided, the time zone specified in the agent is
 used.
      string time_zone = 1;
      Returns:
      This builder for chaining.

    • setTimeZoneBytes

      public QueryParameters.Builder setTimeZoneBytes(com.google.protobuf.ByteString value)
       The time zone of this conversational query from the [time zone
 database](https://www.iana.org/time-zones), e.g., America/New_York,
 Europe/Paris. If not provided, the time zone specified in the agent is
 used.
      string time_zone = 1;
      Parameters:
      value - The bytes for timeZone to set.
      Returns:
      This builder for chaining.

    • hasGeoLocation

      public boolean hasGeoLocation()
       The geo location of this conversational query.
      .google.type.LatLng geo_location = 2;
      Specified by:
      hasGeoLocation in interface QueryParametersOrBuilder
      Returns:
      Whether the geoLocation field is set.

    • getGeoLocation

      public LatLng getGeoLocation()
       The geo location of this conversational query.
      .google.type.LatLng geo_location = 2;
      Specified by:
      getGeoLocation in interface QueryParametersOrBuilder
      Returns:
      The geoLocation.

    • setGeoLocation

      public QueryParameters.Builder setGeoLocation(LatLng value)
       The geo location of this conversational query.
      .google.type.LatLng geo_location = 2;

    • setGeoLocation

      public QueryParameters.Builder setGeoLocation(LatLng.Builder builderForValue)
       The geo location of this conversational query.
      .google.type.LatLng geo_location = 2;

    • mergeGeoLocation

      public QueryParameters.Builder mergeGeoLocation(LatLng value)
       The geo location of this conversational query.
      .google.type.LatLng geo_location = 2;

    • clearGeoLocation

      public QueryParameters.Builder clearGeoLocation()
       The geo location of this conversational query.
      .google.type.LatLng geo_location = 2;

    • getGeoLocationBuilder

      public LatLng.Builder getGeoLocationBuilder()
       The geo location of this conversational query.
      .google.type.LatLng geo_location = 2;

    • getGeoLocationOrBuilder

      public LatLngOrBuilder getGeoLocationOrBuilder()
       The geo location of this conversational query.
      .google.type.LatLng geo_location = 2;
      Specified by:
      getGeoLocationOrBuilder in interface QueryParametersOrBuilder

    • getSessionEntityTypesList

      public List<SessionEntityType> getSessionEntityTypesList()
       Additional session entity types to replace or extend developer entity types
 with. The entity synonyms apply to all languages and persist for the
 session of this query.
      repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;
      Specified by:
      getSessionEntityTypesList in interface QueryParametersOrBuilder

    • getSessionEntityTypesCount

      public int getSessionEntityTypesCount()
       Additional session entity types to replace or extend developer entity types
 with. The entity synonyms apply to all languages and persist for the
 session of this query.
      repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;
      Specified by:
      getSessionEntityTypesCount in interface QueryParametersOrBuilder

    • getSessionEntityTypes

      public SessionEntityType getSessionEntityTypes(int index)
       Additional session entity types to replace or extend developer entity types
 with. The entity synonyms apply to all languages and persist for the
 session of this query.
      repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;
      Specified by:
      getSessionEntityTypes in interface QueryParametersOrBuilder

    • setSessionEntityTypes

      public QueryParameters.Builder setSessionEntityTypes(int index, SessionEntityType value)
       Additional session entity types to replace or extend developer entity types
 with. The entity synonyms apply to all languages and persist for the
 session of this query.
      repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

    • setSessionEntityTypes

      public QueryParameters.Builder setSessionEntityTypes(int index, SessionEntityType.Builder builderForValue)
       Additional session entity types to replace or extend developer entity types
 with. The entity synonyms apply to all languages and persist for the
 session of this query.
      repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

    • addSessionEntityTypes

      public QueryParameters.Builder addSessionEntityTypes(SessionEntityType value)
       Additional session entity types to replace or extend developer entity types
 with. The entity synonyms apply to all languages and persist for the
 session of this query.
      repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

    • addSessionEntityTypes

      public QueryParameters.Builder addSessionEntityTypes(int index, SessionEntityType value)
       Additional session entity types to replace or extend developer entity types
 with. The entity synonyms apply to all languages and persist for the
 session of this query.
      repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

    • addSessionEntityTypes

      public QueryParameters.Builder addSessionEntityTypes(SessionEntityType.Builder builderForValue)
       Additional session entity types to replace or extend developer entity types
 with. The entity synonyms apply to all languages and persist for the
 session of this query.
      repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

    • addSessionEntityTypes

      public QueryParameters.Builder addSessionEntityTypes(int index, SessionEntityType.Builder builderForValue)
       Additional session entity types to replace or extend developer entity types
 with. The entity synonyms apply to all languages and persist for the
 session of this query.
      repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

    • addAllSessionEntityTypes

      public QueryParameters.Builder addAllSessionEntityTypes(Iterable<? extends SessionEntityType> values)
       Additional session entity types to replace or extend developer entity types
 with. The entity synonyms apply to all languages and persist for the
 session of this query.
      repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

    • clearSessionEntityTypes

      public QueryParameters.Builder clearSessionEntityTypes()
       Additional session entity types to replace or extend developer entity types
 with. The entity synonyms apply to all languages and persist for the
 session of this query.
      repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

    • removeSessionEntityTypes

      public QueryParameters.Builder removeSessionEntityTypes(int index)
       Additional session entity types to replace or extend developer entity types
 with. The entity synonyms apply to all languages and persist for the
 session of this query.
      repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

    • getSessionEntityTypesBuilder

      public SessionEntityType.Builder getSessionEntityTypesBuilder(int index)
       Additional session entity types to replace or extend developer entity types
 with. The entity synonyms apply to all languages and persist for the
 session of this query.
      repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

    • getSessionEntityTypesOrBuilder

      public SessionEntityTypeOrBuilder getSessionEntityTypesOrBuilder(int index)
       Additional session entity types to replace or extend developer entity types
 with. The entity synonyms apply to all languages and persist for the
 session of this query.
      repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;
      Specified by:
      getSessionEntityTypesOrBuilder in interface QueryParametersOrBuilder

    • getSessionEntityTypesOrBuilderList

      public List<? extends SessionEntityTypeOrBuilder> getSessionEntityTypesOrBuilderList()
       Additional session entity types to replace or extend developer entity types
 with. The entity synonyms apply to all languages and persist for the
 session of this query.
      repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;
      Specified by:
      getSessionEntityTypesOrBuilderList in interface QueryParametersOrBuilder

    • addSessionEntityTypesBuilder

      public SessionEntityType.Builder addSessionEntityTypesBuilder()
       Additional session entity types to replace or extend developer entity types
 with. The entity synonyms apply to all languages and persist for the
 session of this query.
      repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

    • addSessionEntityTypesBuilder

      public SessionEntityType.Builder addSessionEntityTypesBuilder(int index)
       Additional session entity types to replace or extend developer entity types
 with. The entity synonyms apply to all languages and persist for the
 session of this query.
      repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

    • getSessionEntityTypesBuilderList

      public List<SessionEntityType.Builder> getSessionEntityTypesBuilderList()
       Additional session entity types to replace or extend developer entity types
 with. The entity synonyms apply to all languages and persist for the
 session of this query.
      repeated .google.cloud.dialogflow.cx.v3beta1.SessionEntityType session_entity_types = 3;

    • hasPayload

      public boolean hasPayload()
       This field can be used to pass custom data into the webhook associated with
 the agent. Arbitrary JSON objects are supported.
 Some integrations that query a Dialogflow agent may provide additional
 information in the payload.
 In particular, for the Dialogflow Phone Gateway integration, this field has
 the form:
 ```
 {
 "telephony": {
 "caller_id": "+18558363987"
 }
 }
 ```
      .google.protobuf.Struct payload = 4;
      Specified by:
      hasPayload in interface QueryParametersOrBuilder
      Returns:
      Whether the payload field is set.

    • getPayload

      public com.google.protobuf.Struct getPayload()
       This field can be used to pass custom data into the webhook associated with
 the agent. Arbitrary JSON objects are supported.
 Some integrations that query a Dialogflow agent may provide additional
 information in the payload.
 In particular, for the Dialogflow Phone Gateway integration, this field has
 the form:
 ```
 {
 "telephony": {
 "caller_id": "+18558363987"
 }
 }
 ```
      .google.protobuf.Struct payload = 4;
      Specified by:
      getPayload in interface QueryParametersOrBuilder
      Returns:
      The payload.

    • setPayload

      public QueryParameters.Builder setPayload(com.google.protobuf.Struct value)
       This field can be used to pass custom data into the webhook associated with
 the agent. Arbitrary JSON objects are supported.
 Some integrations that query a Dialogflow agent may provide additional
 information in the payload.
 In particular, for the Dialogflow Phone Gateway integration, this field has
 the form:
 ```
 {
 "telephony": {
 "caller_id": "+18558363987"
 }
 }
 ```
      .google.protobuf.Struct payload = 4;

    • setPayload

      public QueryParameters.Builder setPayload(com.google.protobuf.Struct.Builder builderForValue)
       This field can be used to pass custom data into the webhook associated with
 the agent. Arbitrary JSON objects are supported.
 Some integrations that query a Dialogflow agent may provide additional
 information in the payload.
 In particular, for the Dialogflow Phone Gateway integration, this field has
 the form:
 ```
 {
 "telephony": {
 "caller_id": "+18558363987"
 }
 }
 ```
      .google.protobuf.Struct payload = 4;

    • mergePayload

      public QueryParameters.Builder mergePayload(com.google.protobuf.Struct value)
       This field can be used to pass custom data into the webhook associated with
 the agent. Arbitrary JSON objects are supported.
 Some integrations that query a Dialogflow agent may provide additional
 information in the payload.
 In particular, for the Dialogflow Phone Gateway integration, this field has
 the form:
 ```
 {
 "telephony": {
 "caller_id": "+18558363987"
 }
 }
 ```
      .google.protobuf.Struct payload = 4;

    • clearPayload

      public QueryParameters.Builder clearPayload()
       This field can be used to pass custom data into the webhook associated with
 the agent. Arbitrary JSON objects are supported.
 Some integrations that query a Dialogflow agent may provide additional
 information in the payload.
 In particular, for the Dialogflow Phone Gateway integration, this field has
 the form:
 ```
 {
 "telephony": {
 "caller_id": "+18558363987"
 }
 }
 ```
      .google.protobuf.Struct payload = 4;

    • getPayloadBuilder

      public com.google.protobuf.Struct.Builder getPayloadBuilder()
       This field can be used to pass custom data into the webhook associated with
 the agent. Arbitrary JSON objects are supported.
 Some integrations that query a Dialogflow agent may provide additional
 information in the payload.
 In particular, for the Dialogflow Phone Gateway integration, this field has
 the form:
 ```
 {
 "telephony": {
 "caller_id": "+18558363987"
 }
 }
 ```
      .google.protobuf.Struct payload = 4;

    • getPayloadOrBuilder

      public com.google.protobuf.StructOrBuilder getPayloadOrBuilder()
       This field can be used to pass custom data into the webhook associated with
 the agent. Arbitrary JSON objects are supported.
 Some integrations that query a Dialogflow agent may provide additional
 information in the payload.
 In particular, for the Dialogflow Phone Gateway integration, this field has
 the form:
 ```
 {
 "telephony": {
 "caller_id": "+18558363987"
 }
 }
 ```
      .google.protobuf.Struct payload = 4;
      Specified by:
      getPayloadOrBuilder in interface QueryParametersOrBuilder

    • hasParameters

      public boolean hasParameters()
       Additional parameters to be put into [session
 parameters][SessionInfo.parameters]. To remove a
 parameter from the session, clients should explicitly set the parameter
 value to null.

 You can reference the session parameters in the agent with the following
 format: $session.params.parameter-id.

 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 = 5;
      Specified by:
      hasParameters in interface QueryParametersOrBuilder
      Returns:
      Whether the parameters field is set.

    • getParameters

      public com.google.protobuf.Struct getParameters()
       Additional parameters to be put into [session
 parameters][SessionInfo.parameters]. To remove a
 parameter from the session, clients should explicitly set the parameter
 value to null.

 You can reference the session parameters in the agent with the following
 format: $session.params.parameter-id.

 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 = 5;
      Specified by:
      getParameters in interface QueryParametersOrBuilder
      Returns:
      The parameters.

    • setParameters

      public QueryParameters.Builder setParameters(com.google.protobuf.Struct value)
       Additional parameters to be put into [session
 parameters][SessionInfo.parameters]. To remove a
 parameter from the session, clients should explicitly set the parameter
 value to null.

 You can reference the session parameters in the agent with the following
 format: $session.params.parameter-id.

 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 = 5;

    • setParameters

      public QueryParameters.Builder setParameters(com.google.protobuf.Struct.Builder builderForValue)
       Additional parameters to be put into [session
 parameters][SessionInfo.parameters]. To remove a
 parameter from the session, clients should explicitly set the parameter
 value to null.

 You can reference the session parameters in the agent with the following
 format: $session.params.parameter-id.

 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 = 5;

    • mergeParameters

      public QueryParameters.Builder mergeParameters(com.google.protobuf.Struct value)
       Additional parameters to be put into [session
 parameters][SessionInfo.parameters]. To remove a
 parameter from the session, clients should explicitly set the parameter
 value to null.

 You can reference the session parameters in the agent with the following
 format: $session.params.parameter-id.

 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 = 5;

    • clearParameters

      public QueryParameters.Builder clearParameters()
       Additional parameters to be put into [session
 parameters][SessionInfo.parameters]. To remove a
 parameter from the session, clients should explicitly set the parameter
 value to null.

 You can reference the session parameters in the agent with the following
 format: $session.params.parameter-id.

 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 = 5;

    • getParametersBuilder

      public com.google.protobuf.Struct.Builder getParametersBuilder()
       Additional parameters to be put into [session
 parameters][SessionInfo.parameters]. To remove a
 parameter from the session, clients should explicitly set the parameter
 value to null.

 You can reference the session parameters in the agent with the following
 format: $session.params.parameter-id.

 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 = 5;

    • getParametersOrBuilder

      public com.google.protobuf.StructOrBuilder getParametersOrBuilder()
       Additional parameters to be put into [session
 parameters][SessionInfo.parameters]. To remove a
 parameter from the session, clients should explicitly set the parameter
 value to null.

 You can reference the session parameters in the agent with the following
 format: $session.params.parameter-id.

 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 = 5;
      Specified by:
      getParametersOrBuilder in interface QueryParametersOrBuilder

    • getParameterScope

      public String getParameterScope()
       Scope for the parameters. If not specified, parameters will be treated as
 session parameters. Parameters with custom scope will not be put into
 [session
 parameters][google.cloud.dialogflow.cx.v3beta1.SessionInfo.parameters].

 You can reference the parameters with custom scope in the agent with the
 following format: $parameter-scope.params.parameter-id.
      string parameter_scope = 12;
      Specified by:
      getParameterScope in interface QueryParametersOrBuilder
      Returns:
      The parameterScope.

    • getParameterScopeBytes

      public com.google.protobuf.ByteString getParameterScopeBytes()
       Scope for the parameters. If not specified, parameters will be treated as
 session parameters. Parameters with custom scope will not be put into
 [session
 parameters][google.cloud.dialogflow.cx.v3beta1.SessionInfo.parameters].

 You can reference the parameters with custom scope in the agent with the
 following format: $parameter-scope.params.parameter-id.
      string parameter_scope = 12;
      Specified by:
      getParameterScopeBytes in interface QueryParametersOrBuilder
      Returns:
      The bytes for parameterScope.

    • setParameterScope

      public QueryParameters.Builder setParameterScope(String value)
       Scope for the parameters. If not specified, parameters will be treated as
 session parameters. Parameters with custom scope will not be put into
 [session
 parameters][google.cloud.dialogflow.cx.v3beta1.SessionInfo.parameters].

 You can reference the parameters with custom scope in the agent with the
 following format: $parameter-scope.params.parameter-id.
      string parameter_scope = 12;
      Parameters:
      value - The parameterScope to set.
      Returns:
      This builder for chaining.

    • clearParameterScope

      public QueryParameters.Builder clearParameterScope()
       Scope for the parameters. If not specified, parameters will be treated as
 session parameters. Parameters with custom scope will not be put into
 [session
 parameters][google.cloud.dialogflow.cx.v3beta1.SessionInfo.parameters].

 You can reference the parameters with custom scope in the agent with the
 following format: $parameter-scope.params.parameter-id.
      string parameter_scope = 12;
      Returns:
      This builder for chaining.

    • setParameterScopeBytes

      public QueryParameters.Builder setParameterScopeBytes(com.google.protobuf.ByteString value)
       Scope for the parameters. If not specified, parameters will be treated as
 session parameters. Parameters with custom scope will not be put into
 [session
 parameters][google.cloud.dialogflow.cx.v3beta1.SessionInfo.parameters].

 You can reference the parameters with custom scope in the agent with the
 following format: $parameter-scope.params.parameter-id.
      string parameter_scope = 12;
      Parameters:
      value - The bytes for parameterScope to set.
      Returns:
      This builder for chaining.

    • getCurrentPage

      public String getCurrentPage()
       The unique identifier of the
 [page][google.cloud.dialogflow.cx.v3beta1.Page] to override the [current
 page][QueryResult.current_page] in the session.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.

 If `current_page` is specified, the previous state of the session will be
 ignored by Dialogflow, including the [previous
 page][QueryResult.current_page] and the [previous session
 parameters][QueryResult.parameters].
 In most cases,
 [current_page][google.cloud.dialogflow.cx.v3beta1.QueryParameters.current_page]
 and
 [parameters][google.cloud.dialogflow.cx.v3beta1.QueryParameters.parameters]
 should be configured together to direct a session to a specific state.
      string current_page = 6 [(.google.api.resource_reference) = { ... }
      Specified by:
      getCurrentPage in interface QueryParametersOrBuilder
      Returns:
      The currentPage.

    • getCurrentPageBytes

      public com.google.protobuf.ByteString getCurrentPageBytes()
       The unique identifier of the
 [page][google.cloud.dialogflow.cx.v3beta1.Page] to override the [current
 page][QueryResult.current_page] in the session.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.

 If `current_page` is specified, the previous state of the session will be
 ignored by Dialogflow, including the [previous
 page][QueryResult.current_page] and the [previous session
 parameters][QueryResult.parameters].
 In most cases,
 [current_page][google.cloud.dialogflow.cx.v3beta1.QueryParameters.current_page]
 and
 [parameters][google.cloud.dialogflow.cx.v3beta1.QueryParameters.parameters]
 should be configured together to direct a session to a specific state.
      string current_page = 6 [(.google.api.resource_reference) = { ... }
      Specified by:
      getCurrentPageBytes in interface QueryParametersOrBuilder
      Returns:
      The bytes for currentPage.

    • setCurrentPage

      public QueryParameters.Builder setCurrentPage(String value)
       The unique identifier of the
 [page][google.cloud.dialogflow.cx.v3beta1.Page] to override the [current
 page][QueryResult.current_page] in the session.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.

 If `current_page` is specified, the previous state of the session will be
 ignored by Dialogflow, including the [previous
 page][QueryResult.current_page] and the [previous session
 parameters][QueryResult.parameters].
 In most cases,
 [current_page][google.cloud.dialogflow.cx.v3beta1.QueryParameters.current_page]
 and
 [parameters][google.cloud.dialogflow.cx.v3beta1.QueryParameters.parameters]
 should be configured together to direct a session to a specific state.
      string current_page = 6 [(.google.api.resource_reference) = { ... }
      Parameters:
      value - The currentPage to set.
      Returns:
      This builder for chaining.

    • clearCurrentPage

      public QueryParameters.Builder clearCurrentPage()
       The unique identifier of the
 [page][google.cloud.dialogflow.cx.v3beta1.Page] to override the [current
 page][QueryResult.current_page] in the session.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.

 If `current_page` is specified, the previous state of the session will be
 ignored by Dialogflow, including the [previous
 page][QueryResult.current_page] and the [previous session
 parameters][QueryResult.parameters].
 In most cases,
 [current_page][google.cloud.dialogflow.cx.v3beta1.QueryParameters.current_page]
 and
 [parameters][google.cloud.dialogflow.cx.v3beta1.QueryParameters.parameters]
 should be configured together to direct a session to a specific state.
      string current_page = 6 [(.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setCurrentPageBytes

      public QueryParameters.Builder setCurrentPageBytes(com.google.protobuf.ByteString value)
       The unique identifier of the
 [page][google.cloud.dialogflow.cx.v3beta1.Page] to override the [current
 page][QueryResult.current_page] in the session.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`.

 If `current_page` is specified, the previous state of the session will be
 ignored by Dialogflow, including the [previous
 page][QueryResult.current_page] and the [previous session
 parameters][QueryResult.parameters].
 In most cases,
 [current_page][google.cloud.dialogflow.cx.v3beta1.QueryParameters.current_page]
 and
 [parameters][google.cloud.dialogflow.cx.v3beta1.QueryParameters.parameters]
 should be configured together to direct a session to a specific state.
      string current_page = 6 [(.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for currentPage to set.
      Returns:
      This builder for chaining.

    • getDisableWebhook

      public boolean getDisableWebhook()
       Whether to disable webhook calls for this request.
      bool disable_webhook = 7;
      Specified by:
      getDisableWebhook in interface QueryParametersOrBuilder
      Returns:
      The disableWebhook.

    • setDisableWebhook

      public QueryParameters.Builder setDisableWebhook(boolean value)
       Whether to disable webhook calls for this request.
      bool disable_webhook = 7;
      Parameters:
      value - The disableWebhook to set.
      Returns:
      This builder for chaining.

    • clearDisableWebhook

      public QueryParameters.Builder clearDisableWebhook()
       Whether to disable webhook calls for this request.
      bool disable_webhook = 7;
      Returns:
      This builder for chaining.

    • getAnalyzeQueryTextSentiment

      public boolean getAnalyzeQueryTextSentiment()
       Configures whether sentiment analysis should be performed. If not
 provided, sentiment analysis is not performed.
      bool analyze_query_text_sentiment = 8;
      Specified by:
      getAnalyzeQueryTextSentiment in interface QueryParametersOrBuilder
      Returns:
      The analyzeQueryTextSentiment.

    • setAnalyzeQueryTextSentiment

      public QueryParameters.Builder setAnalyzeQueryTextSentiment(boolean value)
       Configures whether sentiment analysis should be performed. If not
 provided, sentiment analysis is not performed.
      bool analyze_query_text_sentiment = 8;
      Parameters:
      value - The analyzeQueryTextSentiment to set.
      Returns:
      This builder for chaining.

    • clearAnalyzeQueryTextSentiment

      public QueryParameters.Builder clearAnalyzeQueryTextSentiment()
       Configures whether sentiment analysis should be performed. If not
 provided, sentiment analysis is not performed.
      bool analyze_query_text_sentiment = 8;
      Returns:
      This builder for chaining.

    • getWebhookHeadersCount

      public int getWebhookHeadersCount()
      Description copied from interface: QueryParametersOrBuilder
       This field can be used to pass HTTP headers for a webhook
 call. These headers will be sent to webhook along with the headers that
 have been configured through Dialogflow web console. The headers defined
 within this field will overwrite the headers configured through Dialogflow
 console if there is a conflict. Header names are case-insensitive.
 Google's specified headers are not allowed. Including: "Host",
 "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding",
 "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc.
      map<string, string> webhook_headers = 10;
      Specified by:
      getWebhookHeadersCount in interface QueryParametersOrBuilder

    • containsWebhookHeaders

      public boolean containsWebhookHeaders(String key)
       This field can be used to pass HTTP headers for a webhook
 call. These headers will be sent to webhook along with the headers that
 have been configured through Dialogflow web console. The headers defined
 within this field will overwrite the headers configured through Dialogflow
 console if there is a conflict. Header names are case-insensitive.
 Google's specified headers are not allowed. Including: "Host",
 "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding",
 "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc.
      map<string, string> webhook_headers = 10;
      Specified by:
      containsWebhookHeaders in interface QueryParametersOrBuilder

    • getWebhookHeaders

      @Deprecated public Map<String,String> getWebhookHeaders()
      Deprecated.
      Use getWebhookHeadersMap() instead.
      Specified by:
      getWebhookHeaders in interface QueryParametersOrBuilder

    • getWebhookHeadersMap

      public Map<String,String> getWebhookHeadersMap()
       This field can be used to pass HTTP headers for a webhook
 call. These headers will be sent to webhook along with the headers that
 have been configured through Dialogflow web console. The headers defined
 within this field will overwrite the headers configured through Dialogflow
 console if there is a conflict. Header names are case-insensitive.
 Google's specified headers are not allowed. Including: "Host",
 "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding",
 "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc.
      map<string, string> webhook_headers = 10;
      Specified by:
      getWebhookHeadersMap in interface QueryParametersOrBuilder

    • getWebhookHeadersOrDefault

      public String getWebhookHeadersOrDefault(String key, String defaultValue)
       This field can be used to pass HTTP headers for a webhook
 call. These headers will be sent to webhook along with the headers that
 have been configured through Dialogflow web console. The headers defined
 within this field will overwrite the headers configured through Dialogflow
 console if there is a conflict. Header names are case-insensitive.
 Google's specified headers are not allowed. Including: "Host",
 "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding",
 "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc.
      map<string, string> webhook_headers = 10;
      Specified by:
      getWebhookHeadersOrDefault in interface QueryParametersOrBuilder

    • getWebhookHeadersOrThrow

      public String getWebhookHeadersOrThrow(String key)
       This field can be used to pass HTTP headers for a webhook
 call. These headers will be sent to webhook along with the headers that
 have been configured through Dialogflow web console. The headers defined
 within this field will overwrite the headers configured through Dialogflow
 console if there is a conflict. Header names are case-insensitive.
 Google's specified headers are not allowed. Including: "Host",
 "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding",
 "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc.
      map<string, string> webhook_headers = 10;
      Specified by:
      getWebhookHeadersOrThrow in interface QueryParametersOrBuilder

    • clearWebhookHeaders

      public QueryParameters.Builder clearWebhookHeaders()

    • removeWebhookHeaders

      public QueryParameters.Builder removeWebhookHeaders(String key)
       This field can be used to pass HTTP headers for a webhook
 call. These headers will be sent to webhook along with the headers that
 have been configured through Dialogflow web console. The headers defined
 within this field will overwrite the headers configured through Dialogflow
 console if there is a conflict. Header names are case-insensitive.
 Google's specified headers are not allowed. Including: "Host",
 "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding",
 "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc.
      map<string, string> webhook_headers = 10;

    • getMutableWebhookHeaders

      @Deprecated public Map<String,String> getMutableWebhookHeaders()
      Deprecated.
      Use alternate mutation accessors instead.

    • putWebhookHeaders

      public QueryParameters.Builder putWebhookHeaders(String key, String value)
       This field can be used to pass HTTP headers for a webhook
 call. These headers will be sent to webhook along with the headers that
 have been configured through Dialogflow web console. The headers defined
 within this field will overwrite the headers configured through Dialogflow
 console if there is a conflict. Header names are case-insensitive.
 Google's specified headers are not allowed. Including: "Host",
 "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding",
 "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc.
      map<string, string> webhook_headers = 10;

    • putAllWebhookHeaders

      public QueryParameters.Builder putAllWebhookHeaders(Map<String,String> values)
       This field can be used to pass HTTP headers for a webhook
 call. These headers will be sent to webhook along with the headers that
 have been configured through Dialogflow web console. The headers defined
 within this field will overwrite the headers configured through Dialogflow
 console if there is a conflict. Header names are case-insensitive.
 Google's specified headers are not allowed. Including: "Host",
 "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding",
 "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc.
      map<string, string> webhook_headers = 10;

    • getFlowVersionsList

      public com.google.protobuf.ProtocolStringList getFlowVersionsList()
       A list of flow versions to override for the request.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.

 If version 1 of flow X is included in this list, the traffic of
 flow X will go through version 1 regardless of the version configuration
 in the environment. Each flow can have at most one version specified in
 this list.
      repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }
      Specified by:
      getFlowVersionsList in interface QueryParametersOrBuilder
      Returns:
      A list containing the flowVersions.

    • getFlowVersionsCount

      public int getFlowVersionsCount()
       A list of flow versions to override for the request.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.

 If version 1 of flow X is included in this list, the traffic of
 flow X will go through version 1 regardless of the version configuration
 in the environment. Each flow can have at most one version specified in
 this list.
      repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }
      Specified by:
      getFlowVersionsCount in interface QueryParametersOrBuilder
      Returns:
      The count of flowVersions.

    • getFlowVersions

      public String getFlowVersions(int index)
       A list of flow versions to override for the request.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.

 If version 1 of flow X is included in this list, the traffic of
 flow X will go through version 1 regardless of the version configuration
 in the environment. Each flow can have at most one version specified in
 this list.
      repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }
      Specified by:
      getFlowVersions in interface QueryParametersOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The flowVersions at the given index.

    • getFlowVersionsBytes

      public com.google.protobuf.ByteString getFlowVersionsBytes(int index)
       A list of flow versions to override for the request.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.

 If version 1 of flow X is included in this list, the traffic of
 flow X will go through version 1 regardless of the version configuration
 in the environment. Each flow can have at most one version specified in
 this list.
      repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }
      Specified by:
      getFlowVersionsBytes in interface QueryParametersOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the flowVersions at the given index.

    • setFlowVersions

      public QueryParameters.Builder setFlowVersions(int index, String value)
       A list of flow versions to override for the request.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.

 If version 1 of flow X is included in this list, the traffic of
 flow X will go through version 1 regardless of the version configuration
 in the environment. Each flow can have at most one version specified in
 this list.
      repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }
      Parameters:
      index - The index to set the value at.
      value - The flowVersions to set.
      Returns:
      This builder for chaining.

    • addFlowVersions

      public QueryParameters.Builder addFlowVersions(String value)
       A list of flow versions to override for the request.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.

 If version 1 of flow X is included in this list, the traffic of
 flow X will go through version 1 regardless of the version configuration
 in the environment. Each flow can have at most one version specified in
 this list.
      repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }
      Parameters:
      value - The flowVersions to add.
      Returns:
      This builder for chaining.

    • addAllFlowVersions

      public QueryParameters.Builder addAllFlowVersions(Iterable<String> values)
       A list of flow versions to override for the request.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.

 If version 1 of flow X is included in this list, the traffic of
 flow X will go through version 1 regardless of the version configuration
 in the environment. Each flow can have at most one version specified in
 this list.
      repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }
      Parameters:
      values - The flowVersions to add.
      Returns:
      This builder for chaining.

    • clearFlowVersions

      public QueryParameters.Builder clearFlowVersions()
       A list of flow versions to override for the request.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.

 If version 1 of flow X is included in this list, the traffic of
 flow X will go through version 1 regardless of the version configuration
 in the environment. Each flow can have at most one version specified in
 this list.
      repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • addFlowVersionsBytes

      public QueryParameters.Builder addFlowVersionsBytes(com.google.protobuf.ByteString value)
       A list of flow versions to override for the request.
 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`.

 If version 1 of flow X is included in this list, the traffic of
 flow X will go through version 1 regardless of the version configuration
 in the environment. Each flow can have at most one version specified in
 this list.
      repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes of the flowVersions to add.
      Returns:
      This builder for chaining.

    • getCurrentPlaybook

      public String getCurrentPlaybook()
       Optional. The unique identifier of the
 [playbook][google.cloud.dialogflow.cx.v3beta1.Playbook] to start or
 continue the session with. If `current_playbook` is specified, the previous
 state of the session will be ignored by Dialogflow.

 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
      string current_playbook = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getCurrentPlaybook in interface QueryParametersOrBuilder
      Returns:
      The currentPlaybook.

    • getCurrentPlaybookBytes

      public com.google.protobuf.ByteString getCurrentPlaybookBytes()
       Optional. The unique identifier of the
 [playbook][google.cloud.dialogflow.cx.v3beta1.Playbook] to start or
 continue the session with. If `current_playbook` is specified, the previous
 state of the session will be ignored by Dialogflow.

 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
      string current_playbook = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getCurrentPlaybookBytes in interface QueryParametersOrBuilder
      Returns:
      The bytes for currentPlaybook.

    • setCurrentPlaybook

      public QueryParameters.Builder setCurrentPlaybook(String value)
       Optional. The unique identifier of the
 [playbook][google.cloud.dialogflow.cx.v3beta1.Playbook] to start or
 continue the session with. If `current_playbook` is specified, the previous
 state of the session will be ignored by Dialogflow.

 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
      string current_playbook = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The currentPlaybook to set.
      Returns:
      This builder for chaining.

    • clearCurrentPlaybook

      public QueryParameters.Builder clearCurrentPlaybook()
       Optional. The unique identifier of the
 [playbook][google.cloud.dialogflow.cx.v3beta1.Playbook] to start or
 continue the session with. If `current_playbook` is specified, the previous
 state of the session will be ignored by Dialogflow.

 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
      string current_playbook = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setCurrentPlaybookBytes

      public QueryParameters.Builder setCurrentPlaybookBytes(com.google.protobuf.ByteString value)
       Optional. The unique identifier of the
 [playbook][google.cloud.dialogflow.cx.v3beta1.Playbook] to start or
 continue the session with. If `current_playbook` is specified, the previous
 state of the session will be ignored by Dialogflow.

 Format:
 `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
      string current_playbook = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for currentPlaybook to set.
      Returns:
      This builder for chaining.

    • hasLlmModelSettings

      public boolean hasLlmModelSettings()
       Optional. Use the specified LLM model settings for processing the request.
      .google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 21 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasLlmModelSettings in interface QueryParametersOrBuilder
      Returns:
      Whether the llmModelSettings field is set.

    • getLlmModelSettings

      public LlmModelSettings getLlmModelSettings()
       Optional. Use the specified LLM model settings for processing the request.
      .google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 21 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLlmModelSettings in interface QueryParametersOrBuilder
      Returns:
      The llmModelSettings.

    • setLlmModelSettings

      public QueryParameters.Builder setLlmModelSettings(LlmModelSettings value)
       Optional. Use the specified LLM model settings for processing the request.
      .google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 21 [(.google.api.field_behavior) = OPTIONAL];

    • setLlmModelSettings

      public QueryParameters.Builder setLlmModelSettings(LlmModelSettings.Builder builderForValue)
       Optional. Use the specified LLM model settings for processing the request.
      .google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 21 [(.google.api.field_behavior) = OPTIONAL];

    • mergeLlmModelSettings

      public QueryParameters.Builder mergeLlmModelSettings(LlmModelSettings value)
       Optional. Use the specified LLM model settings for processing the request.
      .google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 21 [(.google.api.field_behavior) = OPTIONAL];

    • clearLlmModelSettings

      public QueryParameters.Builder clearLlmModelSettings()
       Optional. Use the specified LLM model settings for processing the request.
      .google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 21 [(.google.api.field_behavior) = OPTIONAL];

    • getLlmModelSettingsBuilder

      public LlmModelSettings.Builder getLlmModelSettingsBuilder()
       Optional. Use the specified LLM model settings for processing the request.
      .google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 21 [(.google.api.field_behavior) = OPTIONAL];

    • getLlmModelSettingsOrBuilder

      public LlmModelSettingsOrBuilder getLlmModelSettingsOrBuilder()
       Optional. Use the specified LLM model settings for processing the request.
      .google.cloud.dialogflow.cx.v3beta1.LlmModelSettings llm_model_settings = 21 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLlmModelSettingsOrBuilder in interface QueryParametersOrBuilder

    • getChannel

      public String getChannel()
       The channel which this query is for.

 If specified, only the
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage]
 associated with the channel will be returned. If no
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage] is
 associated with the channel, it falls back to the
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage] with
 unspecified channel.

 If unspecified, the
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage] with
 unspecified channel will be returned.
      string channel = 15;
      Specified by:
      getChannel in interface QueryParametersOrBuilder
      Returns:
      The channel.

    • getChannelBytes

      public com.google.protobuf.ByteString getChannelBytes()
       The channel which this query is for.

 If specified, only the
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage]
 associated with the channel will be returned. If no
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage] is
 associated with the channel, it falls back to the
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage] with
 unspecified channel.

 If unspecified, the
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage] with
 unspecified channel will be returned.
      string channel = 15;
      Specified by:
      getChannelBytes in interface QueryParametersOrBuilder
      Returns:
      The bytes for channel.

    • setChannel

      public QueryParameters.Builder setChannel(String value)
       The channel which this query is for.

 If specified, only the
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage]
 associated with the channel will be returned. If no
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage] is
 associated with the channel, it falls back to the
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage] with
 unspecified channel.

 If unspecified, the
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage] with
 unspecified channel will be returned.
      string channel = 15;
      Parameters:
      value - The channel to set.
      Returns:
      This builder for chaining.

    • clearChannel

      public QueryParameters.Builder clearChannel()
       The channel which this query is for.

 If specified, only the
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage]
 associated with the channel will be returned. If no
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage] is
 associated with the channel, it falls back to the
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage] with
 unspecified channel.

 If unspecified, the
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage] with
 unspecified channel will be returned.
      string channel = 15;
      Returns:
      This builder for chaining.

    • setChannelBytes

      public QueryParameters.Builder setChannelBytes(com.google.protobuf.ByteString value)
       The channel which this query is for.

 If specified, only the
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage]
 associated with the channel will be returned. If no
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage] is
 associated with the channel, it falls back to the
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage] with
 unspecified channel.

 If unspecified, the
 [ResponseMessage][google.cloud.dialogflow.cx.v3beta1.ResponseMessage] with
 unspecified channel will be returned.
      string channel = 15;
      Parameters:
      value - The bytes for channel to set.
      Returns:
      This builder for chaining.

    • hasSessionTtl

      public boolean hasSessionTtl()
       Optional. Configure lifetime of the Dialogflow session.
 By default, a Dialogflow session remains active and its data is stored for
 30 minutes after the last request is sent for the session.
 This value should be no longer than 1 day.
      .google.protobuf.Duration session_ttl = 16 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasSessionTtl in interface QueryParametersOrBuilder
      Returns:
      Whether the sessionTtl field is set.

    • getSessionTtl

      public com.google.protobuf.Duration getSessionTtl()
       Optional. Configure lifetime of the Dialogflow session.
 By default, a Dialogflow session remains active and its data is stored for
 30 minutes after the last request is sent for the session.
 This value should be no longer than 1 day.
      .google.protobuf.Duration session_ttl = 16 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSessionTtl in interface QueryParametersOrBuilder
      Returns:
      The sessionTtl.

    • setSessionTtl

      public QueryParameters.Builder setSessionTtl(com.google.protobuf.Duration value)
       Optional. Configure lifetime of the Dialogflow session.
 By default, a Dialogflow session remains active and its data is stored for
 30 minutes after the last request is sent for the session.
 This value should be no longer than 1 day.
      .google.protobuf.Duration session_ttl = 16 [(.google.api.field_behavior) = OPTIONAL];

    • setSessionTtl

      public QueryParameters.Builder setSessionTtl(com.google.protobuf.Duration.Builder builderForValue)
       Optional. Configure lifetime of the Dialogflow session.
 By default, a Dialogflow session remains active and its data is stored for
 30 minutes after the last request is sent for the session.
 This value should be no longer than 1 day.
      .google.protobuf.Duration session_ttl = 16 [(.google.api.field_behavior) = OPTIONAL];

    • mergeSessionTtl

      public QueryParameters.Builder mergeSessionTtl(com.google.protobuf.Duration value)
       Optional. Configure lifetime of the Dialogflow session.
 By default, a Dialogflow session remains active and its data is stored for
 30 minutes after the last request is sent for the session.
 This value should be no longer than 1 day.
      .google.protobuf.Duration session_ttl = 16 [(.google.api.field_behavior) = OPTIONAL];

    • clearSessionTtl

      public QueryParameters.Builder clearSessionTtl()
       Optional. Configure lifetime of the Dialogflow session.
 By default, a Dialogflow session remains active and its data is stored for
 30 minutes after the last request is sent for the session.
 This value should be no longer than 1 day.
      .google.protobuf.Duration session_ttl = 16 [(.google.api.field_behavior) = OPTIONAL];

    • getSessionTtlBuilder

      public com.google.protobuf.Duration.Builder getSessionTtlBuilder()
       Optional. Configure lifetime of the Dialogflow session.
 By default, a Dialogflow session remains active and its data is stored for
 30 minutes after the last request is sent for the session.
 This value should be no longer than 1 day.
      .google.protobuf.Duration session_ttl = 16 [(.google.api.field_behavior) = OPTIONAL];

    • getSessionTtlOrBuilder

      public com.google.protobuf.DurationOrBuilder getSessionTtlOrBuilder()
       Optional. Configure lifetime of the Dialogflow session.
 By default, a Dialogflow session remains active and its data is stored for
 30 minutes after the last request is sent for the session.
 This value should be no longer than 1 day.
      .google.protobuf.Duration session_ttl = 16 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSessionTtlOrBuilder in interface QueryParametersOrBuilder

    • hasEndUserMetadata

      public boolean hasEndUserMetadata()
       Optional. Information about the end-user to improve the relevance and
 accuracy of generative answers.

 This will be interpreted and used by a language model, so, for good
 results, the data should be self-descriptive, and in a simple structure.

 Example:

 ```json
 {
 "subscription plan": "Business Premium Plus",
 "devices owned": [
 {"model": "Google Pixel 7"},
 {"model": "Google Pixel Tablet"}
 ]
 }
 ```
      .google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasEndUserMetadata in interface QueryParametersOrBuilder
      Returns:
      Whether the endUserMetadata field is set.

    • getEndUserMetadata

      public com.google.protobuf.Struct getEndUserMetadata()
       Optional. Information about the end-user to improve the relevance and
 accuracy of generative answers.

 This will be interpreted and used by a language model, so, for good
 results, the data should be self-descriptive, and in a simple structure.

 Example:

 ```json
 {
 "subscription plan": "Business Premium Plus",
 "devices owned": [
 {"model": "Google Pixel 7"},
 {"model": "Google Pixel Tablet"}
 ]
 }
 ```
      .google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEndUserMetadata in interface QueryParametersOrBuilder
      Returns:
      The endUserMetadata.

    • setEndUserMetadata

      public QueryParameters.Builder setEndUserMetadata(com.google.protobuf.Struct value)
       Optional. Information about the end-user to improve the relevance and
 accuracy of generative answers.

 This will be interpreted and used by a language model, so, for good
 results, the data should be self-descriptive, and in a simple structure.

 Example:

 ```json
 {
 "subscription plan": "Business Premium Plus",
 "devices owned": [
 {"model": "Google Pixel 7"},
 {"model": "Google Pixel Tablet"}
 ]
 }
 ```
      .google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];

    • setEndUserMetadata

      public QueryParameters.Builder setEndUserMetadata(com.google.protobuf.Struct.Builder builderForValue)
       Optional. Information about the end-user to improve the relevance and
 accuracy of generative answers.

 This will be interpreted and used by a language model, so, for good
 results, the data should be self-descriptive, and in a simple structure.

 Example:

 ```json
 {
 "subscription plan": "Business Premium Plus",
 "devices owned": [
 {"model": "Google Pixel 7"},
 {"model": "Google Pixel Tablet"}
 ]
 }
 ```
      .google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];

    • mergeEndUserMetadata

      public QueryParameters.Builder mergeEndUserMetadata(com.google.protobuf.Struct value)
       Optional. Information about the end-user to improve the relevance and
 accuracy of generative answers.

 This will be interpreted and used by a language model, so, for good
 results, the data should be self-descriptive, and in a simple structure.

 Example:

 ```json
 {
 "subscription plan": "Business Premium Plus",
 "devices owned": [
 {"model": "Google Pixel 7"},
 {"model": "Google Pixel Tablet"}
 ]
 }
 ```
      .google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];

    • clearEndUserMetadata

      public QueryParameters.Builder clearEndUserMetadata()
       Optional. Information about the end-user to improve the relevance and
 accuracy of generative answers.

 This will be interpreted and used by a language model, so, for good
 results, the data should be self-descriptive, and in a simple structure.

 Example:

 ```json
 {
 "subscription plan": "Business Premium Plus",
 "devices owned": [
 {"model": "Google Pixel 7"},
 {"model": "Google Pixel Tablet"}
 ]
 }
 ```
      .google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];

    • getEndUserMetadataBuilder

      public com.google.protobuf.Struct.Builder getEndUserMetadataBuilder()
       Optional. Information about the end-user to improve the relevance and
 accuracy of generative answers.

 This will be interpreted and used by a language model, so, for good
 results, the data should be self-descriptive, and in a simple structure.

 Example:

 ```json
 {
 "subscription plan": "Business Premium Plus",
 "devices owned": [
 {"model": "Google Pixel 7"},
 {"model": "Google Pixel Tablet"}
 ]
 }
 ```
      .google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];

    • getEndUserMetadataOrBuilder

      public com.google.protobuf.StructOrBuilder getEndUserMetadataOrBuilder()
       Optional. Information about the end-user to improve the relevance and
 accuracy of generative answers.

 This will be interpreted and used by a language model, so, for good
 results, the data should be self-descriptive, and in a simple structure.

 Example:

 ```json
 {
 "subscription plan": "Business Premium Plus",
 "devices owned": [
 {"model": "Google Pixel 7"},
 {"model": "Google Pixel Tablet"}
 ]
 }
 ```
      .google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEndUserMetadataOrBuilder in interface QueryParametersOrBuilder

    • hasSearchConfig

      public boolean hasSearchConfig()
       Optional. Search configuration for UCS search queries.
      .google.cloud.dialogflow.cx.v3beta1.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasSearchConfig in interface QueryParametersOrBuilder
      Returns:
      Whether the searchConfig field is set.

    • getSearchConfig

      public SearchConfig getSearchConfig()
       Optional. Search configuration for UCS search queries.
      .google.cloud.dialogflow.cx.v3beta1.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSearchConfig in interface QueryParametersOrBuilder
      Returns:
      The searchConfig.

    • setSearchConfig

      public QueryParameters.Builder setSearchConfig(SearchConfig value)
       Optional. Search configuration for UCS search queries.
      .google.cloud.dialogflow.cx.v3beta1.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];

    • setSearchConfig

      public QueryParameters.Builder setSearchConfig(SearchConfig.Builder builderForValue)
       Optional. Search configuration for UCS search queries.
      .google.cloud.dialogflow.cx.v3beta1.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];

    • mergeSearchConfig

      public QueryParameters.Builder mergeSearchConfig(SearchConfig value)
       Optional. Search configuration for UCS search queries.
      .google.cloud.dialogflow.cx.v3beta1.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];

    • clearSearchConfig

      public QueryParameters.Builder clearSearchConfig()
       Optional. Search configuration for UCS search queries.
      .google.cloud.dialogflow.cx.v3beta1.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];

    • getSearchConfigBuilder

      public SearchConfig.Builder getSearchConfigBuilder()
       Optional. Search configuration for UCS search queries.
      .google.cloud.dialogflow.cx.v3beta1.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];

    • getSearchConfigOrBuilder

      public SearchConfigOrBuilder getSearchConfigOrBuilder()
       Optional. Search configuration for UCS search queries.
      .google.cloud.dialogflow.cx.v3beta1.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSearchConfigOrBuilder in interface QueryParametersOrBuilder

    • getPopulateDataStoreConnectionSignals

      @Deprecated public boolean getPopulateDataStoreConnectionSignals()
      Deprecated.
      google.cloud.dialogflow.cx.v3beta1.QueryParameters.populate_data_store_connection_signals is deprecated. See google/cloud/dialogflow/cx/v3beta1/session.proto;l=775
       Optional. If set to true and data stores are involved in serving the
 request then
 DetectIntentResponse.query_result.data_store_connection_signals
 will be filled with data that can help evaluations.
      bool populate_data_store_connection_signals = 25 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPopulateDataStoreConnectionSignals in interface QueryParametersOrBuilder
      Returns:
      The populateDataStoreConnectionSignals.

    • setPopulateDataStoreConnectionSignals

      @Deprecated public QueryParameters.Builder setPopulateDataStoreConnectionSignals(boolean value)
      Deprecated.
      google.cloud.dialogflow.cx.v3beta1.QueryParameters.populate_data_store_connection_signals is deprecated. See google/cloud/dialogflow/cx/v3beta1/session.proto;l=775
       Optional. If set to true and data stores are involved in serving the
 request then
 DetectIntentResponse.query_result.data_store_connection_signals
 will be filled with data that can help evaluations.
      bool populate_data_store_connection_signals = 25 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The populateDataStoreConnectionSignals to set.
      Returns:
      This builder for chaining.

    • clearPopulateDataStoreConnectionSignals

      @Deprecated public QueryParameters.Builder clearPopulateDataStoreConnectionSignals()
      Deprecated.
      google.cloud.dialogflow.cx.v3beta1.QueryParameters.populate_data_store_connection_signals is deprecated. See google/cloud/dialogflow/cx/v3beta1/session.proto;l=775
       Optional. If set to true and data stores are involved in serving the
 request then
 DetectIntentResponse.query_result.data_store_connection_signals
 will be filled with data that can help evaluations.
      bool populate_data_store_connection_signals = 25 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.