com.google.cloud.dialogflow.v2beta1

Interface QueryParametersOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

QueryParameters, QueryParameters.Builder

public interface QueryParametersOrBuilder
extends 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.
Context	getContexts(int index) The collection of contexts to be activated before this query is executed.
int	getContextsCount() The collection of contexts to be activated before this query is executed.
List<Context>	getContextsList() The collection of contexts to be activated before this query is executed.
ContextOrBuilder	getContextsOrBuilder(int index) The collection of contexts to be activated before this query is executed.
List<? extends ContextOrBuilder>	getContextsOrBuilderList() The collection of contexts to be activated before this query is executed.
com.google.type.LatLng	getGeoLocation() The geo location of this conversational query.
com.google.type.LatLngOrBuilder	getGeoLocationOrBuilder() The geo location of this conversational query.
String	getKnowledgeBaseNames(int index) KnowledgeBases to get alternative results from.
ByteString	getKnowledgeBaseNamesBytes(int index) KnowledgeBases to get alternative results from.
int	getKnowledgeBaseNamesCount() KnowledgeBases to get alternative results from.
List<String>	getKnowledgeBaseNamesList() KnowledgeBases to get alternative results from.
Struct	getPayload() This field can be used to pass custom data to your webhook.
StructOrBuilder	getPayloadOrBuilder() This field can be used to pass custom data to your webhook.
boolean	getResetContexts() Specifies whether to delete all contexts in the current session before the new ones are activated.
SentimentAnalysisRequestConfig	getSentimentAnalysisRequestConfig() Configures the type of sentiment analysis to perform.
SentimentAnalysisRequestConfigOrBuilder	getSentimentAnalysisRequestConfigOrBuilder() Configures the type of sentiment analysis to perform.
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.
SubAgent	getSubAgents(int index) For mega agent query, directly specify which sub agents to query.
int	getSubAgentsCount() For mega agent query, directly specify which sub agents to query.
List<SubAgent>	getSubAgentsList() For mega agent query, directly specify which sub agents to query.
SubAgentOrBuilder	getSubAgentsOrBuilder(int index) For mega agent query, directly specify which sub agents to query.
List<? extends SubAgentOrBuilder>	getSubAgentsOrBuilderList() For mega agent query, directly specify which sub agents to query.
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.
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	hasPayload() This field can be used to pass custom data to your webhook.
boolean	hasSentimentAnalysisRequestConfig() Configures the type of sentiment analysis to perform.

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
 agent settings is used.
 

string time_zone = 1;

Returns:

The timeZone.

getTimeZoneBytes

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
 agent settings 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;

getContextsList

List<Context> getContextsList()

 The collection of contexts to be activated before this query is
 executed.
 

repeated .google.cloud.dialogflow.v2beta1.Context contexts = 3;

getContexts

Context getContexts(int index)

 The collection of contexts to be activated before this query is
 executed.
 

repeated .google.cloud.dialogflow.v2beta1.Context contexts = 3;

getContextsCount

int getContextsCount()

 The collection of contexts to be activated before this query is
 executed.
 

repeated .google.cloud.dialogflow.v2beta1.Context contexts = 3;

getContextsOrBuilderList

List<? extends ContextOrBuilder> getContextsOrBuilderList()

 The collection of contexts to be activated before this query is
 executed.
 

repeated .google.cloud.dialogflow.v2beta1.Context contexts = 3;

getContextsOrBuilder

ContextOrBuilder getContextsOrBuilder(int index)

 The collection of contexts to be activated before this query is
 executed.
 

repeated .google.cloud.dialogflow.v2beta1.Context contexts = 3;

getResetContexts

boolean getResetContexts()

 Specifies whether to delete all contexts in the current session
 before the new ones are activated.
 

bool reset_contexts = 4;

Returns:

The resetContexts.

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.v2beta1.SessionEntityType session_entity_types = 5;

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.v2beta1.SessionEntityType session_entity_types = 5;

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.v2beta1.SessionEntityType session_entity_types = 5;

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.v2beta1.SessionEntityType session_entity_types = 5;

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.v2beta1.SessionEntityType session_entity_types = 5;

hasPayload

boolean hasPayload()

 This field can be used to pass custom data to your webhook.
 Arbitrary JSON objects are supported.
 If supplied, the value is used to populate the
 `WebhookRequest.original_detect_intent_request.payload`
 field sent to your webhook.
 

.google.protobuf.Struct payload = 6;

Returns:

Whether the payload field is set.

getPayload

Struct getPayload()

 This field can be used to pass custom data to your webhook.
 Arbitrary JSON objects are supported.
 If supplied, the value is used to populate the
 `WebhookRequest.original_detect_intent_request.payload`
 field sent to your webhook.
 

.google.protobuf.Struct payload = 6;

Returns:

The payload.

getPayloadOrBuilder

StructOrBuilder getPayloadOrBuilder()

 This field can be used to pass custom data to your webhook.
 Arbitrary JSON objects are supported.
 If supplied, the value is used to populate the
 `WebhookRequest.original_detect_intent_request.payload`
 field sent to your webhook.
 

.google.protobuf.Struct payload = 6;

getKnowledgeBaseNamesList

List<String> getKnowledgeBaseNamesList()

 KnowledgeBases to get alternative results from. If not set, the
 KnowledgeBases enabled in the agent (through UI) will be used.
 Format:  `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
 

repeated string knowledge_base_names = 12;

Returns:

A list containing the knowledgeBaseNames.

getKnowledgeBaseNamesCount

int getKnowledgeBaseNamesCount()

 KnowledgeBases to get alternative results from. If not set, the
 KnowledgeBases enabled in the agent (through UI) will be used.
 Format:  `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
 

repeated string knowledge_base_names = 12;

Returns:

The count of knowledgeBaseNames.

getKnowledgeBaseNames

String getKnowledgeBaseNames(int index)

 KnowledgeBases to get alternative results from. If not set, the
 KnowledgeBases enabled in the agent (through UI) will be used.
 Format:  `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
 

repeated string knowledge_base_names = 12;

Parameters:

index - The index of the element to return.

Returns:

The knowledgeBaseNames at the given index.

getKnowledgeBaseNamesBytes

ByteString getKnowledgeBaseNamesBytes(int index)

 KnowledgeBases to get alternative results from. If not set, the
 KnowledgeBases enabled in the agent (through UI) will be used.
 Format:  `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>`.
 

repeated string knowledge_base_names = 12;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the knowledgeBaseNames at the given index.

hasSentimentAnalysisRequestConfig

boolean hasSentimentAnalysisRequestConfig()

 Configures the type of sentiment analysis to perform. If not
 provided, sentiment analysis is not performed.
 Note: Sentiment Analysis is only currently available for Essentials Edition
 agents.
 

.google.cloud.dialogflow.v2beta1.SentimentAnalysisRequestConfig sentiment_analysis_request_config = 10;

Returns:

Whether the sentimentAnalysisRequestConfig field is set.

getSentimentAnalysisRequestConfig

SentimentAnalysisRequestConfig getSentimentAnalysisRequestConfig()

 Configures the type of sentiment analysis to perform. If not
 provided, sentiment analysis is not performed.
 Note: Sentiment Analysis is only currently available for Essentials Edition
 agents.
 

.google.cloud.dialogflow.v2beta1.SentimentAnalysisRequestConfig sentiment_analysis_request_config = 10;

Returns:

The sentimentAnalysisRequestConfig.

getSentimentAnalysisRequestConfigOrBuilder

SentimentAnalysisRequestConfigOrBuilder getSentimentAnalysisRequestConfigOrBuilder()

 Configures the type of sentiment analysis to perform. If not
 provided, sentiment analysis is not performed.
 Note: Sentiment Analysis is only currently available for Essentials Edition
 agents.
 

.google.cloud.dialogflow.v2beta1.SentimentAnalysisRequestConfig sentiment_analysis_request_config = 10;

getSubAgentsList

List<SubAgent> getSubAgentsList()

 For mega agent query, directly specify which sub agents to query.
 If any specified sub agent is not linked to the mega agent, an error will
 be returned. If empty, Dialogflow will decide which sub agents to query.
 If specified for a non-mega-agent query, will be silently ignored.
 

repeated .google.cloud.dialogflow.v2beta1.SubAgent sub_agents = 13;

getSubAgents

SubAgent getSubAgents(int index)

 For mega agent query, directly specify which sub agents to query.
 If any specified sub agent is not linked to the mega agent, an error will
 be returned. If empty, Dialogflow will decide which sub agents to query.
 If specified for a non-mega-agent query, will be silently ignored.
 

repeated .google.cloud.dialogflow.v2beta1.SubAgent sub_agents = 13;

getSubAgentsCount

int getSubAgentsCount()

 For mega agent query, directly specify which sub agents to query.
 If any specified sub agent is not linked to the mega agent, an error will
 be returned. If empty, Dialogflow will decide which sub agents to query.
 If specified for a non-mega-agent query, will be silently ignored.
 

repeated .google.cloud.dialogflow.v2beta1.SubAgent sub_agents = 13;

getSubAgentsOrBuilderList

List<? extends SubAgentOrBuilder> getSubAgentsOrBuilderList()

 For mega agent query, directly specify which sub agents to query.
 If any specified sub agent is not linked to the mega agent, an error will
 be returned. If empty, Dialogflow will decide which sub agents to query.
 If specified for a non-mega-agent query, will be silently ignored.
 

repeated .google.cloud.dialogflow.v2beta1.SubAgent sub_agents = 13;

getSubAgentsOrBuilder

SubAgentOrBuilder getSubAgentsOrBuilder(int index)

 For mega agent query, directly specify which sub agents to query.
 If any specified sub agent is not linked to the mega agent, an error will
 be returned. If empty, Dialogflow will decide which sub agents to query.
 If specified for a non-mega-agent query, will be silently ignored.
 

repeated .google.cloud.dialogflow.v2beta1.SubAgent sub_agents = 13;

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

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

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

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

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