Interface QueryParametersOrBuilder (4.6.0)

Version 4.6.0

• 4.59.0 (latest)
• 4.58.0
• 4.57.0
• 4.55.0
• 4.54.0
• 4.53.0
• 4.52.0
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.47.0
• 4.46.0
• 4.45.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.33.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.1
• 4.8.6
• 4.7.5
• 4.6.0
• 4.5.11
• 4.4.0
• 4.3.1

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

Parameter

Name	Description
key	String

Returns

Type	Description
boolean

getContexts(int index)

public abstract Context getContexts(int index)

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

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

Parameter

Name	Description
index	int

Returns

Type	Description
Context

getContextsCount()

public abstract int getContextsCount()

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

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

Returns

Type	Description
int

getContextsList()

public abstract List<Context> getContextsList()

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

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

Returns

Type	Description
List<Context>

getContextsOrBuilder(int index)

public abstract ContextOrBuilder getContextsOrBuilder(int index)

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

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

Parameter

Name	Description
index	int

Returns

Type	Description
ContextOrBuilder

getContextsOrBuilderList()

public abstract List<? extends ContextOrBuilder> getContextsOrBuilderList()

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

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

Returns

Type	Description
List<? extends com.google.cloud.dialogflow.v2beta1.ContextOrBuilder>

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

getKnowledgeBaseNames(int index)

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

Parameter

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

Returns

Type	Description
String	The knowledgeBaseNames at the given index.

getKnowledgeBaseNamesBytes(int index)

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

Parameter

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

Returns

Type	Description
ByteString	The bytes of the knowledgeBaseNames at the given index.

getKnowledgeBaseNamesCount()

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

Type	Description
int	The count of knowledgeBaseNames.

getKnowledgeBaseNamesList()

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

Type	Description
List<String>	A list containing the knowledgeBaseNames.

getPayload()

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

Type	Description
Struct	The payload.

getPayloadOrBuilder()

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

Returns

Type	Description
StructOrBuilder

getResetContexts()

public abstract boolean getResetContexts()

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

bool reset_contexts = 4;

Returns

Type	Description
boolean	The resetContexts.

getSentimentAnalysisRequestConfig()

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

Type	Description
SentimentAnalysisRequestConfig	The sentimentAnalysisRequestConfig.

getSentimentAnalysisRequestConfigOrBuilder()

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

Returns

Type	Description
SentimentAnalysisRequestConfigOrBuilder

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

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

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

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

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

Returns

Type	Description
List<? extends com.google.cloud.dialogflow.v2beta1.SessionEntityTypeOrBuilder>

getSubAgents(int index)

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

Parameter

Name	Description
index	int

Returns

Type	Description
SubAgent

getSubAgentsCount()

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

Returns

Type	Description
int

getSubAgentsList()

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

Returns

Type	Description
List<SubAgent>

getSubAgentsOrBuilder(int index)

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

Parameter

Name	Description
index	int

Returns

Type	Description
SubAgentOrBuilder

getSubAgentsOrBuilderList()

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

Returns

Type	Description
List<? extends com.google.cloud.dialogflow.v2beta1.SubAgentOrBuilder>

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

string time_zone = 1;

Returns

Type	Description
ByteString	The bytes for timeZone.

getWebhookHeaders()

public abstract Map<String,String> getWebhookHeaders()

Use #getWebhookHeadersMap() instead.

Returns

Type	Description
Map<String,String>

getWebhookHeadersCount()

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

Returns

Type	Description
int

getWebhookHeadersMap()

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

Returns

Type	Description
Map<String,String>

getWebhookHeadersOrDefault(String key, String defaultValue)

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

Parameters

Name	Description
key	String
defaultValue	String

Returns

Type	Description
String

getWebhookHeadersOrThrow(String key)

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

Parameter

Name	Description
key	String

Returns

Type	Description
String

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.

hasPayload()

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

Type	Description
boolean	Whether the payload field is set.

hasSentimentAnalysisRequestConfig()

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

Type	Description
boolean	Whether the sentimentAnalysisRequestConfig field is set.