Class QueryParameters.Builder (4.22.0) 

public static final class QueryParameters.Builder extends GeneratedMessageV3.Builder<QueryParameters.Builder> implements QueryParametersOrBuilder

Represents the parameters of the conversational query.

Protobuf type google.cloud.dialogflow.v2beta1.QueryParameters

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > QueryParameters.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllContexts(Iterable<? extends Context> values)

public QueryParameters.Builder addAllContexts(Iterable<? extends Context> values)

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

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.dialogflow.v2beta1.Context>
Returns
Type Description
QueryParameters.Builder

addAllKnowledgeBaseNames(Iterable<String> values)

public QueryParameters.Builder addAllKnowledgeBaseNames(Iterable<String> values)

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
values Iterable<String>

The knowledgeBaseNames to add.
Returns
Type Description
QueryParameters.Builder

This builder for chaining.

addAllSessionEntityTypes(Iterable<? extends SessionEntityType> values)

public QueryParameters.Builder addAllSessionEntityTypes(Iterable<? extends SessionEntityType> values)

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
values Iterable<? extends com.google.cloud.dialogflow.v2beta1.SessionEntityType>
Returns
Type Description
QueryParameters.Builder

addAllSubAgents(Iterable<? extends SubAgent> values)

public QueryParameters.Builder addAllSubAgents(Iterable<? extends SubAgent> values)

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
values Iterable<? extends com.google.cloud.dialogflow.v2beta1.SubAgent>
Returns
Type Description
QueryParameters.Builder

addContexts(Context value)

public QueryParameters.Builder addContexts(Context value)

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

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

Parameter
Name Description
value Context
Returns
Type Description
QueryParameters.Builder

addContexts(Context.Builder builderForValue)

public QueryParameters.Builder addContexts(Context.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Context.Builder
Returns
Type Description
QueryParameters.Builder

addContexts(int index, Context value)

public QueryParameters.Builder addContexts(int index, Context value)

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

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

Parameters
Name Description
index int
value Context
Returns
Type Description
QueryParameters.Builder

addContexts(int index, Context.Builder builderForValue)

public QueryParameters.Builder addContexts(int index, Context.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue Context.Builder
Returns
Type Description
QueryParameters.Builder

addContextsBuilder()

public Context.Builder addContextsBuilder()

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

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

Returns
Type Description
Context.Builder

addContextsBuilder(int index)

public Context.Builder addContextsBuilder(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.Builder

addKnowledgeBaseNames(String value)

public QueryParameters.Builder addKnowledgeBaseNames(String value)

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
value String

The knowledgeBaseNames to add.
Returns
Type Description
QueryParameters.Builder

This builder for chaining.

addKnowledgeBaseNamesBytes(ByteString value)

public QueryParameters.Builder addKnowledgeBaseNamesBytes(ByteString value)

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
value ByteString

The bytes of the knowledgeBaseNames to add.
Returns
Type Description
QueryParameters.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public QueryParameters.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
QueryParameters.Builder
Overrides

addSessionEntityTypes(SessionEntityType value)

public QueryParameters.Builder addSessionEntityTypes(SessionEntityType value)

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
value SessionEntityType
Returns
Type Description
QueryParameters.Builder

addSessionEntityTypes(SessionEntityType.Builder builderForValue)

public QueryParameters.Builder addSessionEntityTypes(SessionEntityType.Builder builderForValue)

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
builderForValue SessionEntityType.Builder
Returns
Type Description
QueryParameters.Builder

addSessionEntityTypes(int index, SessionEntityType value)

public QueryParameters.Builder addSessionEntityTypes(int index, SessionEntityType value)

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;

Parameters
Name Description
index int
value SessionEntityType
Returns
Type Description
QueryParameters.Builder

addSessionEntityTypes(int index, SessionEntityType.Builder builderForValue)

public QueryParameters.Builder addSessionEntityTypes(int index, SessionEntityType.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue SessionEntityType.Builder
Returns
Type Description
QueryParameters.Builder

addSessionEntityTypesBuilder()

public SessionEntityType.Builder addSessionEntityTypesBuilder()

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
SessionEntityType.Builder

addSessionEntityTypesBuilder(int index)

public SessionEntityType.Builder addSessionEntityTypesBuilder(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.Builder

addSubAgents(SubAgent value)

public QueryParameters.Builder addSubAgents(SubAgent value)

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
value SubAgent
Returns
Type Description
QueryParameters.Builder

addSubAgents(SubAgent.Builder builderForValue)

public QueryParameters.Builder addSubAgents(SubAgent.Builder builderForValue)

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
builderForValue SubAgent.Builder
Returns
Type Description
QueryParameters.Builder

addSubAgents(int index, SubAgent value)

public QueryParameters.Builder addSubAgents(int index, SubAgent value)

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;

Parameters
Name Description
index int
value SubAgent
Returns
Type Description
QueryParameters.Builder

addSubAgents(int index, SubAgent.Builder builderForValue)

public QueryParameters.Builder addSubAgents(int index, SubAgent.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue SubAgent.Builder
Returns
Type Description
QueryParameters.Builder

addSubAgentsBuilder()

public SubAgent.Builder addSubAgentsBuilder()

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
SubAgent.Builder

addSubAgentsBuilder(int index)

public SubAgent.Builder addSubAgentsBuilder(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.Builder

build()

public QueryParameters build()
Returns
Type Description
QueryParameters

buildPartial()

public QueryParameters buildPartial()
Returns
Type Description
QueryParameters

clear()

public QueryParameters.Builder clear()
Returns
Type Description
QueryParameters.Builder
Overrides

clearContexts()

public QueryParameters.Builder clearContexts()

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

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

Returns
Type Description
QueryParameters.Builder

clearField(Descriptors.FieldDescriptor field)

public QueryParameters.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
QueryParameters.Builder
Overrides

clearGeoLocation()

public QueryParameters.Builder clearGeoLocation()

The geo location of this conversational query.

.google.type.LatLng geo_location = 2;

Returns
Type Description
QueryParameters.Builder

clearKnowledgeBaseNames()

public QueryParameters.Builder clearKnowledgeBaseNames()

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
QueryParameters.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public QueryParameters.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
QueryParameters.Builder
Overrides

clearPayload()

public QueryParameters.Builder clearPayload()

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
QueryParameters.Builder

clearResetContexts()

public QueryParameters.Builder clearResetContexts()

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

bool reset_contexts = 4;

Returns
Type Description
QueryParameters.Builder

This builder for chaining.

clearSentimentAnalysisRequestConfig()

public QueryParameters.Builder clearSentimentAnalysisRequestConfig()

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
QueryParameters.Builder

clearSessionEntityTypes()

public QueryParameters.Builder clearSessionEntityTypes()

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
QueryParameters.Builder

clearSubAgents()

public QueryParameters.Builder clearSubAgents()

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
QueryParameters.Builder

clearTimeZone()

public QueryParameters.Builder clearTimeZone()

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
QueryParameters.Builder

This builder for chaining.

clearWebhookHeaders()

public QueryParameters.Builder clearWebhookHeaders()
Returns
Type Description
QueryParameters.Builder

clone()

public QueryParameters.Builder clone()
Returns
Type Description
QueryParameters.Builder
Overrides

containsWebhookHeaders(String key)

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

Parameter
Name Description
key String
Returns
Type Description
boolean

getContexts(int index)

public 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

getContextsBuilder(int index)

public Context.Builder getContextsBuilder(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.Builder

getContextsBuilderList()

public List<Context.Builder> getContextsBuilderList()

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

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

Returns
Type Description
List<Builder>

getContextsCount()

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

getDefaultInstanceForType()

public QueryParameters getDefaultInstanceForType()
Returns
Type Description
QueryParameters

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getGeoLocation()

public LatLng getGeoLocation()

The geo location of this conversational query.

.google.type.LatLng geo_location = 2;

Returns
Type Description
com.google.type.LatLng

The geoLocation.

getGeoLocationBuilder()

public LatLng.Builder getGeoLocationBuilder()

The geo location of this conversational query.

.google.type.LatLng geo_location = 2;

Returns
Type Description
com.google.type.LatLng.Builder

getGeoLocationOrBuilder()

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

A list containing the knowledgeBaseNames.

getMutableWebhookHeaders()

public Map<String,String> getMutableWebhookHeaders()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getPayload()

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

getPayloadBuilder()

public Struct.Builder getPayloadBuilder()

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
Builder

getPayloadOrBuilder()

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

getSentimentAnalysisRequestConfigBuilder()

public SentimentAnalysisRequestConfig.Builder getSentimentAnalysisRequestConfigBuilder()

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

getSentimentAnalysisRequestConfigOrBuilder()

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

getSessionEntityTypesBuilder(int index)

public SessionEntityType.Builder getSessionEntityTypesBuilder(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.Builder

getSessionEntityTypesBuilderList()

public List<SessionEntityType.Builder> getSessionEntityTypesBuilderList()

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<Builder>

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

Returns
Type Description
int

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

Returns
Type Description
List<SessionEntityType>

getSessionEntityTypesOrBuilder(int index)

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

Parameter
Name Description
index int
Returns
Type Description
SessionEntityTypeOrBuilder

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

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

getSubAgents(int index)

public 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

getSubAgentsBuilder(int index)

public SubAgent.Builder getSubAgentsBuilder(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.Builder

getSubAgentsBuilderList()

public List<SubAgent.Builder> getSubAgentsBuilderList()

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<Builder>

getSubAgentsCount()

public 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 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 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 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 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 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 Map<String,String> getWebhookHeaders()

Use #getWebhookHeadersMap() instead.

Returns
Type Description
Map<String,String>

getWebhookHeadersCount()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(QueryParameters other)

public QueryParameters.Builder mergeFrom(QueryParameters other)
Parameter
Name Description
other QueryParameters
Returns
Type Description
QueryParameters.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public QueryParameters.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryParameters.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public QueryParameters.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
QueryParameters.Builder
Overrides

mergeGeoLocation(LatLng value)

public QueryParameters.Builder mergeGeoLocation(LatLng value)

The geo location of this conversational query.

.google.type.LatLng geo_location = 2;

Parameter
Name Description
value com.google.type.LatLng
Returns
Type Description
QueryParameters.Builder

mergePayload(Struct value)

public QueryParameters.Builder mergePayload(Struct value)

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;

Parameter
Name Description
value Struct
Returns
Type Description
QueryParameters.Builder

mergeSentimentAnalysisRequestConfig(SentimentAnalysisRequestConfig value)

public QueryParameters.Builder mergeSentimentAnalysisRequestConfig(SentimentAnalysisRequestConfig value)

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;

Parameter
Name Description
value SentimentAnalysisRequestConfig
Returns
Type Description
QueryParameters.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final QueryParameters.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
QueryParameters.Builder
Overrides

putAllWebhookHeaders(Map<String,String> values)

public QueryParameters.Builder putAllWebhookHeaders(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
QueryParameters.Builder

putWebhookHeaders(String key, String value)

public QueryParameters.Builder putWebhookHeaders(String key, String value)

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
value String
Returns
Type Description
QueryParameters.Builder

removeContexts(int index)

public QueryParameters.Builder removeContexts(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
QueryParameters.Builder

removeSessionEntityTypes(int index)

public QueryParameters.Builder removeSessionEntityTypes(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
QueryParameters.Builder

removeSubAgents(int index)

public QueryParameters.Builder removeSubAgents(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
QueryParameters.Builder

removeWebhookHeaders(String key)

public QueryParameters.Builder removeWebhookHeaders(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
QueryParameters.Builder

setContexts(int index, Context value)

public QueryParameters.Builder setContexts(int index, Context value)

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

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

Parameters
Name Description
index int
value Context
Returns
Type Description
QueryParameters.Builder

setContexts(int index, Context.Builder builderForValue)

public QueryParameters.Builder setContexts(int index, Context.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue Context.Builder
Returns
Type Description
QueryParameters.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public QueryParameters.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
QueryParameters.Builder
Overrides

setGeoLocation(LatLng value)

public QueryParameters.Builder setGeoLocation(LatLng value)

The geo location of this conversational query.

.google.type.LatLng geo_location = 2;

Parameter
Name Description
value com.google.type.LatLng
Returns
Type Description
QueryParameters.Builder

setGeoLocation(LatLng.Builder builderForValue)

public QueryParameters.Builder setGeoLocation(LatLng.Builder builderForValue)

The geo location of this conversational query.

.google.type.LatLng geo_location = 2;

Parameter
Name Description
builderForValue com.google.type.LatLng.Builder
Returns
Type Description
QueryParameters.Builder

setKnowledgeBaseNames(int index, String value)

public QueryParameters.Builder setKnowledgeBaseNames(int index, String value)

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
Name Description
index int

The index to set the value at.
value String

The knowledgeBaseNames to set.
Returns
Type Description
QueryParameters.Builder

This builder for chaining.

setPayload(Struct value)

public QueryParameters.Builder setPayload(Struct value)

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;

Parameter
Name Description
value Struct
Returns
Type Description
QueryParameters.Builder

setPayload(Struct.Builder builderForValue)

public QueryParameters.Builder setPayload(Struct.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
QueryParameters.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public QueryParameters.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
QueryParameters.Builder
Overrides

setResetContexts(boolean value)

public QueryParameters.Builder setResetContexts(boolean value)

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

bool reset_contexts = 4;

Parameter
Name Description
value boolean

The resetContexts to set.
Returns
Type Description
QueryParameters.Builder

This builder for chaining.

setSentimentAnalysisRequestConfig(SentimentAnalysisRequestConfig value)

public QueryParameters.Builder setSentimentAnalysisRequestConfig(SentimentAnalysisRequestConfig value)

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;

Parameter
Name Description
value SentimentAnalysisRequestConfig
Returns
Type Description
QueryParameters.Builder

setSentimentAnalysisRequestConfig(SentimentAnalysisRequestConfig.Builder builderForValue)

public QueryParameters.Builder setSentimentAnalysisRequestConfig(SentimentAnalysisRequestConfig.Builder builderForValue)

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;

Parameter
Name Description
builderForValue SentimentAnalysisRequestConfig.Builder
Returns
Type Description
QueryParameters.Builder

setSessionEntityTypes(int index, SessionEntityType value)

public QueryParameters.Builder setSessionEntityTypes(int index, SessionEntityType value)

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;

Parameters
Name Description
index int
value SessionEntityType
Returns
Type Description
QueryParameters.Builder

setSessionEntityTypes(int index, SessionEntityType.Builder builderForValue)

public QueryParameters.Builder setSessionEntityTypes(int index, SessionEntityType.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue SessionEntityType.Builder
Returns
Type Description
QueryParameters.Builder

setSubAgents(int index, SubAgent value)

public QueryParameters.Builder setSubAgents(int index, SubAgent value)

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;

Parameters
Name Description
index int
value SubAgent
Returns
Type Description
QueryParameters.Builder

setSubAgents(int index, SubAgent.Builder builderForValue)

public QueryParameters.Builder setSubAgents(int index, SubAgent.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue SubAgent.Builder
Returns
Type Description
QueryParameters.Builder

setTimeZone(String value)

public QueryParameters.Builder setTimeZone(String value)

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;

Parameter
Name Description
value String

The timeZone to set.
Returns
Type Description
QueryParameters.Builder

This builder for chaining.

setTimeZoneBytes(ByteString value)

public QueryParameters.Builder setTimeZoneBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for timeZone to set.
Returns
Type Description
QueryParameters.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final QueryParameters.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
QueryParameters.Builder
Overrides