com.google.cloud.dialogflow.cx.v3

Interface QueryParametersOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

QueryParameters, QueryParameters.Builder

public interface QueryParametersOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsWebhookHeaders(String key) This field can be used to pass HTTP headers for a webhook call.
boolean	getAnalyzeQueryTextSentiment() Configures whether sentiment analysis should be performed.
String	getCurrentPage() The unique identifier of the [page][google.cloud.dialogflow.cx.v3.Page] to override the [current page][QueryResult.current_page] in the session.
com.google.protobuf.ByteString	getCurrentPageBytes() The unique identifier of the [page][google.cloud.dialogflow.cx.v3.Page] to override the [current page][QueryResult.current_page] in the session.
boolean	getDisableWebhook() Whether to disable webhook calls for this request.
String	getFlowVersions(int index) A list of flow versions to override for the request.
com.google.protobuf.ByteString	getFlowVersionsBytes(int index) A list of flow versions to override for the request.
int	getFlowVersionsCount() A list of flow versions to override for the request.
List<String>	getFlowVersionsList() A list of flow versions to override for the request.
com.google.type.LatLng	getGeoLocation() The geo location of this conversational query.
com.google.type.LatLngOrBuilder	getGeoLocationOrBuilder() The geo location of this conversational query.
com.google.protobuf.Struct	getParameters() Additional parameters to be put into [session parameters][SessionInfo.parameters].
com.google.protobuf.StructOrBuilder	getParametersOrBuilder() Additional parameters to be put into [session parameters][SessionInfo.parameters].
com.google.protobuf.Struct	getPayload() This field can be used to pass custom data into the webhook associated with the agent.
com.google.protobuf.StructOrBuilder	getPayloadOrBuilder() This field can be used to pass custom data into the webhook associated with the agent.
SessionEntityType	getSessionEntityTypes(int index) Additional session entity types to replace or extend developer entity types with.
int	getSessionEntityTypesCount() Additional session entity types to replace or extend developer entity types with.
List<SessionEntityType>	getSessionEntityTypesList() Additional session entity types to replace or extend developer entity types with.
SessionEntityTypeOrBuilder	getSessionEntityTypesOrBuilder(int index) Additional session entity types to replace or extend developer entity types with.
List<? extends SessionEntityTypeOrBuilder>	getSessionEntityTypesOrBuilderList() Additional session entity types to replace or extend developer entity types with.
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.
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.
Map<String,String>	getWebhookHeaders() Deprecated.
int	getWebhookHeadersCount() This field can be used to pass HTTP headers for a webhook call.
Map<String,String>	getWebhookHeadersMap() This field can be used to pass HTTP headers for a webhook call.
String	getWebhookHeadersOrDefault(String key, String defaultValue) This field can be used to pass HTTP headers for a webhook call.
String	getWebhookHeadersOrThrow(String key) This field can be used to pass HTTP headers for a webhook call.
boolean	hasGeoLocation() The geo location of this conversational query.
boolean	hasParameters() Additional parameters to be put into [session parameters][SessionInfo.parameters].
boolean	hasPayload() This field can be used to pass custom data into the webhook associated with the agent.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getTimeZone

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;

Returns:

The timeZone.

getTimeZoneBytes

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;

Returns:

The bytes for timeZone.

hasGeoLocation

boolean hasGeoLocation()

 The geo location of this conversational query.
 

.google.type.LatLng geo_location = 2;

Returns:

Whether the geoLocation field is set.

getGeoLocation

com.google.type.LatLng getGeoLocation()

 The geo location of this conversational query.
 

.google.type.LatLng geo_location = 2;

Returns:

The geoLocation.

getGeoLocationOrBuilder

com.google.type.LatLngOrBuilder getGeoLocationOrBuilder()

 The geo location of this conversational query.
 

.google.type.LatLng geo_location = 2;

getSessionEntityTypesList

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;

getSessionEntityTypes

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;

getSessionEntityTypesCount

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;

getSessionEntityTypesOrBuilderList

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;

getSessionEntityTypesOrBuilder

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;

hasPayload

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;

Returns:

Whether the payload field is set.

getPayload

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;

Returns:

The payload.

getPayloadOrBuilder

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;

hasParameters

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;

Returns:

Whether the parameters field is set.

getParameters

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;

Returns:

The parameters.

getParametersOrBuilder

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;

getCurrentPage

String getCurrentPage()

 The unique identifier of the [page][google.cloud.dialogflow.cx.v3.Page] to override the [current
 page][QueryResult.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][QueryResult.current_page] and the [previous session
 parameters][QueryResult.parameters].
 In most cases, [current_page][google.cloud.dialogflow.cx.v3.QueryParameters.current_page] and
 [parameters][google.cloud.dialogflow.cx.v3.QueryParameters.parameters] should be configured together to
 direct a session to a specific state.
 

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

Returns:

The currentPage.

getCurrentPageBytes

com.google.protobuf.ByteString getCurrentPageBytes()

 The unique identifier of the [page][google.cloud.dialogflow.cx.v3.Page] to override the [current
 page][QueryResult.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][QueryResult.current_page] and the [previous session
 parameters][QueryResult.parameters].
 In most cases, [current_page][google.cloud.dialogflow.cx.v3.QueryParameters.current_page] and
 [parameters][google.cloud.dialogflow.cx.v3.QueryParameters.parameters] should be configured together to
 direct a session to a specific state.
 

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

Returns:

The bytes for currentPage.

getDisableWebhook

boolean getDisableWebhook()

 Whether to disable webhook calls for this request.
 

bool disable_webhook = 7;

Returns:

The disableWebhook.

getAnalyzeQueryTextSentiment

boolean getAnalyzeQueryTextSentiment()

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

bool analyze_query_text_sentiment = 8;

Returns:

The analyzeQueryTextSentiment.

getWebhookHeadersCount

int getWebhookHeadersCount()

 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;

containsWebhookHeaders

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;

getWebhookHeaders

@Deprecated
Map<String,String> getWebhookHeaders()

Deprecated.

Use getWebhookHeadersMap() instead.

getWebhookHeadersMap

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;

getWebhookHeadersOrDefault

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;

getWebhookHeadersOrThrow

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;

getFlowVersionsList

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>`.
 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:

A list containing the flowVersions.

getFlowVersionsCount

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>`.
 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:

The count of flowVersions.

getFlowVersions

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

Parameters:

index - The index of the element to return.

Returns:

The flowVersions at the given index.

getFlowVersionsBytes

com.google.protobuf.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>`.
 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 of the value to return.

Returns:

The bytes of the flowVersions at the given index.