com.google.cloud.dialogflow.v2beta1.QueryParametersOrBuilder Maven / Gradle / Ivy
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/dialogflow/v2beta1/session.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.dialogflow.v2beta1;
public interface QueryParametersOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.v2beta1.QueryParameters)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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;
*
* @return The timeZone.
*/
java.lang.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;
*
* @return The bytes for timeZone.
*/
com.google.protobuf.ByteString getTimeZoneBytes();
/**
*
*
*
* The geo location of this conversational query.
*
*
* .google.type.LatLng geo_location = 2;
*
* @return Whether the geoLocation field is set.
*/
boolean hasGeoLocation();
/**
*
*
*
* The geo location of this conversational query.
*
*
* .google.type.LatLng geo_location = 2;
*
* @return The geoLocation.
*/
com.google.type.LatLng getGeoLocation();
/**
*
*
*
* The geo location of this conversational query.
*
*
* .google.type.LatLng geo_location = 2;
*/
com.google.type.LatLngOrBuilder getGeoLocationOrBuilder();
/**
*
*
*
* The collection of contexts to be activated before this query is
* executed.
*
*
* repeated .google.cloud.dialogflow.v2beta1.Context contexts = 3;
*/
java.util.List getContextsList();
/**
*
*
*
* The collection of contexts to be activated before this query is
* executed.
*
*
* repeated .google.cloud.dialogflow.v2beta1.Context contexts = 3;
*/
com.google.cloud.dialogflow.v2beta1.Context getContexts(int index);
/**
*
*
*
* The collection of contexts to be activated before this query is
* executed.
*
*
* repeated .google.cloud.dialogflow.v2beta1.Context contexts = 3;
*/
int getContextsCount();
/**
*
*
*
* The collection of contexts to be activated before this query is
* executed.
*
*
* repeated .google.cloud.dialogflow.v2beta1.Context contexts = 3;
*/
java.util.List
getContextsOrBuilderList();
/**
*
*
*
* The collection of contexts to be activated before this query is
* executed.
*
*
* repeated .google.cloud.dialogflow.v2beta1.Context contexts = 3;
*/
com.google.cloud.dialogflow.v2beta1.ContextOrBuilder getContextsOrBuilder(int index);
/**
*
*
*
* Specifies whether to delete all contexts in the current session
* before the new ones are activated.
*
*
* bool reset_contexts = 4;
*
* @return The resetContexts.
*/
boolean getResetContexts();
/**
*
*
*
* 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;
*
*/
java.util.List 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;
*
*/
com.google.cloud.dialogflow.v2beta1.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;
*
*/
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;
*
*/
java.util.List
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;
*
*/
com.google.cloud.dialogflow.v2beta1.SessionEntityTypeOrBuilder getSessionEntityTypesOrBuilder(
int index);
/**
*
*
*
* 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;
*
* @return Whether the payload field is set.
*/
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;
*
* @return The payload.
*/
com.google.protobuf.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;
*/
com.google.protobuf.StructOrBuilder getPayloadOrBuilder();
/**
*
*
*
* 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;
*
* @return A list containing the knowledgeBaseNames.
*/
java.util.List 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;
*
* @return The count of knowledgeBaseNames.
*/
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;
*
* @param index The index of the element to return.
* @return The knowledgeBaseNames at the given index.
*/
java.lang.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;
*
* @param index The index of the value to return.
* @return The bytes of the knowledgeBaseNames at the given index.
*/
com.google.protobuf.ByteString getKnowledgeBaseNamesBytes(int index);
/**
*
*
*
* 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;
*
*
* @return Whether the sentimentAnalysisRequestConfig field is set.
*/
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;
*
*
* @return The sentimentAnalysisRequestConfig.
*/
com.google.cloud.dialogflow.v2beta1.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;
*
*/
com.google.cloud.dialogflow.v2beta1.SentimentAnalysisRequestConfigOrBuilder
getSentimentAnalysisRequestConfigOrBuilder();
/**
*
*
*
* 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;
*/
java.util.List 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;
*/
com.google.cloud.dialogflow.v2beta1.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;
*/
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;
*/
java.util.List
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;
*/
com.google.cloud.dialogflow.v2beta1.SubAgentOrBuilder getSubAgentsOrBuilder(int index);
/**
*
*
*
* 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;
*/
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;
*/
boolean containsWebhookHeaders(java.lang.String key);
/** Use {@link #getWebhookHeadersMap()} instead. */
@java.lang.Deprecated
java.util.Map getWebhookHeaders();
/**
*
*
*
* 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;
*/
java.util.Map 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;
*/
/* nullable */
java.lang.String getWebhookHeadersOrDefault(
java.lang.String key,
/* nullable */
java.lang.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;
*/
java.lang.String getWebhookHeadersOrThrow(java.lang.String key);
/**
*
*
*
* 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][google.cloud.dialogflow.v2beta1.Intent.Message.platform].
*
*
* string platform = 18;
*
* @return The platform.
*/
java.lang.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][google.cloud.dialogflow.v2beta1.Intent.Message.platform].
*
*
* string platform = 18;
*
* @return The bytes for platform.
*/
com.google.protobuf.ByteString getPlatformBytes();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy