Interface QueryParametersOrBuilder (4.59.0)

public interface QueryParametersOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsWebhookHeaders(String key)

public abstract boolean containsWebhookHeaders(String key)

This field can be used to pass HTTP headers for a webhook call. These headers will be sent to webhook along with the headers that have been configured through Dialogflow web console. The headers defined within this field will overwrite the headers configured through Dialogflow console if there is a conflict. Header names are case-insensitive. Google's specified headers are not allowed. Including: "Host", "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding", "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc.

map<string, string> webhook_headers = 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()

.google.protobuf.Struct payload = 6;

Returns
Type	Description
`StructOrBuilder`

getPlatform()

public abstract String getPlatform()

The platform of the virtual agent response messages.

If not empty, only emits messages from this platform in the response. Valid values are the enum names of platform.

string platform = 18;

Returns
Type	Description
`String`	The platform.

getPlatformBytes()

public abstract ByteString getPlatformBytes()

The platform of the virtual agent response messages.

If not empty, only emits messages from this platform in the response. Valid values are the enum names of platform.

string platform = 18;

Returns
Type	Description
`ByteString`	The bytes for platform.

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.