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

Class QueryParameters

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.cx.v3beta1.QueryParameters
All Implemented Interfaces:
QueryParametersOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class QueryParameters extends com.google.protobuf.GeneratedMessage implements QueryParametersOrBuilder
 Represents the parameters of a conversational query.
Protobuf type google.cloud.dialogflow.cx.v3beta1.QueryParameters
See Also:

  • Field Details

    • TIME_ZONE_FIELD_NUMBER

      public static final int TIME_ZONE_FIELD_NUMBER
      See Also:

    • GEO_LOCATION_FIELD_NUMBER

      public static final int GEO_LOCATION_FIELD_NUMBER
      See Also:

    • SESSION_ENTITY_TYPES_FIELD_NUMBER

      public static final int SESSION_ENTITY_TYPES_FIELD_NUMBER
      See Also:

    • PAYLOAD_FIELD_NUMBER

      public static final int PAYLOAD_FIELD_NUMBER
      See Also:

    • PARAMETERS_FIELD_NUMBER

      public static final int PARAMETERS_FIELD_NUMBER
      See Also:

    • PARAMETER_SCOPE_FIELD_NUMBER

      public static final int PARAMETER_SCOPE_FIELD_NUMBER
      See Also:

    • CURRENT_PAGE_FIELD_NUMBER

      public static final int CURRENT_PAGE_FIELD_NUMBER
      See Also:

    • DISABLE_WEBHOOK_FIELD_NUMBER

      public static final int DISABLE_WEBHOOK_FIELD_NUMBER
      See Also:

    • ANALYZE_QUERY_TEXT_SENTIMENT_FIELD_NUMBER

      public static final int ANALYZE_QUERY_TEXT_SENTIMENT_FIELD_NUMBER
      See Also:

    • WEBHOOK_HEADERS_FIELD_NUMBER

      public static final int WEBHOOK_HEADERS_FIELD_NUMBER
      See Also:

    • FLOW_VERSIONS_FIELD_NUMBER

      public static final int FLOW_VERSIONS_FIELD_NUMBER
      See Also:

    • CURRENT_PLAYBOOK_FIELD_NUMBER

      public static final int CURRENT_PLAYBOOK_FIELD_NUMBER
      See Also:

    • LLM_MODEL_SETTINGS_FIELD_NUMBER

      public static final int LLM_MODEL_SETTINGS_FIELD_NUMBER
      See Also:

    • CHANNEL_FIELD_NUMBER

      public static final int CHANNEL_FIELD_NUMBER
      See Also:

    • SESSION_TTL_FIELD_NUMBER

      public static final int SESSION_TTL_FIELD_NUMBER
      See Also:

    • END_USER_METADATA_FIELD_NUMBER

      public static final int END_USER_METADATA_FIELD_NUMBER
      See Also:

    • SEARCH_CONFIG_FIELD_NUMBER

      public static final int SEARCH_CONFIG_FIELD_NUMBER
      See Also:

    • POPULATE_DATA_STORE_CONNECTION_SIGNALS_FIELD_NUMBER

      public static final int POPULATE_DATA_STORE_CONNECTION_SIGNALS_FIELD_NUMBER
      See Also:

  • 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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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.

    • 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.

    • 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

    • 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

    • 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

    • 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

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static QueryParameters parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QueryParameters parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QueryParameters parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QueryParameters parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QueryParameters parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QueryParameters parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static QueryParameters parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static QueryParameters parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static QueryParameters parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static QueryParameters parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static QueryParameters parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static QueryParameters parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static QueryParameters.Builder newBuilder()

    • newBuilder

      public static QueryParameters.Builder newBuilder(QueryParameters prototype)

    • toBuilder

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

    • newBuilderForType

      protected QueryParameters.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static QueryParameters getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<QueryParameters> parser()

    • getParserForType

      public com.google.protobuf.Parser<QueryParameters> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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