Interface QueryParametersOrBuilder (0.54.0)

public interface QueryParametersOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsWebhookHeaders(String key)

public abstract 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;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getAnalyzeQueryTextSentiment()

public abstract boolean getAnalyzeQueryTextSentiment()

Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed.

bool analyze_query_text_sentiment = 8;

Returns
Type	Description
`boolean`	The analyzeQueryTextSentiment.

getChannel()

public abstract String getChannel()

The channel which this query is for.

If specified, only the ResponseMessage associated with the channel will be returned. If no ResponseMessage is associated with the channel, it falls back to the ResponseMessage with unspecified channel.

If unspecified, the ResponseMessage with unspecified channel will be returned.

string channel = 15;

Returns
Type	Description
`String`	The channel.

getChannelBytes()

public abstract ByteString getChannelBytes()

The channel which this query is for.

If unspecified, the ResponseMessage with unspecified channel will be returned.

string channel = 15;

Returns
Type	Description
`ByteString`	The bytes for channel.

getCurrentPage()

public abstract String getCurrentPage()

The unique identifier of the page to override the current page in the session. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

If current_page is specified, the previous state of the session will be ignored by Dialogflow, including the previous page and the previous session parameters. In most cases, current_page and parameters should be configured together to direct a session to a specific state.

string current_page = 6 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The currentPage.

getCurrentPageBytes()

public abstract ByteString getCurrentPageBytes()

The unique identifier of the page to override the current page in the session. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

string current_page = 6 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for currentPage.

getDisableWebhook()

public abstract boolean getDisableWebhook()

Whether to disable webhook calls for this request.

bool disable_webhook = 7;

Returns
Type	Description
`boolean`	The disableWebhook.

getEndUserMetadata()

public abstract 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:

<code><code>json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } </code></code>

.google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Struct`	The endUserMetadata.

getEndUserMetadataOrBuilder()

public abstract 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:

<code><code>json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } </code></code>

.google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`StructOrBuilder`

getFlowVersions(int index)

public abstract String getFlowVersions(int index)

A list of flow versions to override for the request. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

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) = { ... }

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The flowVersions at the given index.

getFlowVersionsBytes(int index)

public abstract ByteString getFlowVersionsBytes(int index)

A list of flow versions to override for the request. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the flowVersions at the given index.

getFlowVersionsCount()

public abstract int getFlowVersionsCount()

A list of flow versions to override for the request. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`int`	The count of flowVersions.

getFlowVersionsList()

public abstract List<String> getFlowVersionsList()

A list of flow versions to override for the request. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>.

repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`List<String>`	A list containing the flowVersions.

getGeoLocation()

public abstract LatLng getGeoLocation()

The geo location of this conversational query.

.google.type.LatLng geo_location = 2;

Returns
Type	Description
`com.google.type.LatLng`	The geoLocation.

getGeoLocationOrBuilder()

public abstract LatLngOrBuilder getGeoLocationOrBuilder()

The geo location of this conversational query.

.google.type.LatLng geo_location = 2;

Returns
Type	Description
`com.google.type.LatLngOrBuilder`

getParameters()

public abstract Struct getParameters()

Additional parameters to be put into session 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;

Returns
Type	Description
`Struct`	The parameters.

getParametersOrBuilder()

public abstract StructOrBuilder getParametersOrBuilder()

Additional parameters to be put into session 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;

Returns
Type	Description
`StructOrBuilder`

getPayload()

public abstract 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: <code><code> { "telephony": { "caller_id": "+18558363987" } } </code></code>

.google.protobuf.Struct payload = 4;

Returns
Type	Description
`Struct`	The payload.

getPayloadOrBuilder()

public abstract StructOrBuilder getPayloadOrBuilder()

.google.protobuf.Struct payload = 4;

Returns
Type	Description
`StructOrBuilder`

getSearchConfig()

public abstract SearchConfig getSearchConfig()

Optional. Search configuration for UCS search queries.

.google.cloud.dialogflow.cx.v3.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`SearchConfig`	The searchConfig.

getSearchConfigOrBuilder()

public abstract SearchConfigOrBuilder getSearchConfigOrBuilder()

Optional. Search configuration for UCS search queries.

.google.cloud.dialogflow.cx.v3.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`SearchConfigOrBuilder`

getSessionEntityTypes(int index)

public abstract 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.v3.SessionEntityType session_entity_types = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SessionEntityType`

getSessionEntityTypesCount()

public abstract 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.v3.SessionEntityType session_entity_types = 3;

Returns
Type	Description
`int`

getSessionEntityTypesList()

public abstract 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.v3.SessionEntityType session_entity_types = 3;

Returns
Type	Description
`List<SessionEntityType>`

getSessionEntityTypesOrBuilder(int index)

public abstract 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.v3.SessionEntityType session_entity_types = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SessionEntityTypeOrBuilder`

getSessionEntityTypesOrBuilderList()

public abstract 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.v3.SessionEntityType session_entity_types = 3;

Returns
Type	Description
`List<? extends com.google.cloud.dialogflow.cx.v3.SessionEntityTypeOrBuilder>`

getSessionTtl()

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

Returns
Type	Description
`Duration`	The sessionTtl.

getSessionTtlOrBuilder()

public abstract DurationOrBuilder getSessionTtlOrBuilder()

.google.protobuf.Duration session_ttl = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`DurationOrBuilder`

getTimeZone()

public abstract String getTimeZone()

The time zone of this conversational query from the time zone database, e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in the agent is used.

string time_zone = 1;

Returns
Type	Description
`String`	The timeZone.

getTimeZoneBytes()

public abstract ByteString getTimeZoneBytes()

The time zone of this conversational query from the time zone database, e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in the agent is used.

string time_zone = 1;

Returns
Type	Description
`ByteString`	The bytes for timeZone.

getWebhookHeaders() (deprecated)

public abstract Map<String,String> getWebhookHeaders()

Use #getWebhookHeadersMap() instead.

Returns
Type	Description
`Map<String,String>`

getWebhookHeadersCount()

public abstract int getWebhookHeadersCount()

map<string, string> webhook_headers = 10;

Returns
Type	Description
`int`

getWebhookHeadersMap()

public abstract Map<String,String> getWebhookHeadersMap()

map<string, string> webhook_headers = 10;

Returns
Type	Description
`Map<String,String>`

getWebhookHeadersOrDefault(String key, String defaultValue)

public abstract String getWebhookHeadersOrDefault(String key, String defaultValue)

map<string, string> webhook_headers = 10;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getWebhookHeadersOrThrow(String key)

public abstract String getWebhookHeadersOrThrow(String key)

map<string, string> webhook_headers = 10;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

hasEndUserMetadata()

public abstract 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:

<code><code>json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } </code></code>

.google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the endUserMetadata field is set.

hasGeoLocation()

public abstract boolean hasGeoLocation()

The geo location of this conversational query.

.google.type.LatLng geo_location = 2;

Returns
Type	Description
`boolean`	Whether the geoLocation field is set.

hasParameters()

public abstract boolean hasParameters()

Additional parameters to be put into session 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;

Returns
Type	Description
`boolean`	Whether the parameters field is set.

hasPayload()

public abstract boolean hasPayload()

.google.protobuf.Struct payload = 4;

Returns
Type	Description
`boolean`	Whether the payload field is set.

hasSearchConfig()

public abstract boolean hasSearchConfig()

Optional. Search configuration for UCS search queries.

.google.cloud.dialogflow.cx.v3.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the searchConfig field is set.

hasSessionTtl()

public abstract boolean hasSessionTtl()

.google.protobuf.Duration session_ttl = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the sessionTtl field is set.