Package com.google.cloud.dialogflow.v2beta1

Class QueryParameters

  • All Implemented Interfaces:
    QueryParametersOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class QueryParameters
extends com.google.protobuf.GeneratedMessageV3
implements QueryParametersOrBuilder
     Represents the parameters of the conversational query.
    Protobuf type google.cloud.dialogflow.v2beta1.QueryParameters
    See Also:
    Serialized Form

    • Field Detail

      • GEO_LOCATION_FIELD_NUMBER

        public static final int GEO_LOCATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RESET_CONTEXTS_FIELD_NUMBER

        public static final int RESET_CONTEXTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SESSION_ENTITY_TYPES_FIELD_NUMBER

        public static final int SESSION_ENTITY_TYPES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • KNOWLEDGE_BASE_NAMES_FIELD_NUMBER

        public static final int KNOWLEDGE_BASE_NAMES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SENTIMENT_ANALYSIS_REQUEST_CONFIG_FIELD_NUMBER

        public static final int SENTIMENT_ANALYSIS_REQUEST_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUB_AGENTS_FIELD_NUMBER

        public static final int SUB_AGENTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WEBHOOK_HEADERS_FIELD_NUMBER

        public static final int WEBHOOK_HEADERS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getTimeZone

        public 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;
        Specified by:
        getTimeZone in interface QueryParametersOrBuilder
        Returns:
        The timeZone.

      • getTimeZoneBytes

        public com.google.protobuf.ByteString getTimeZoneBytes()
         The time zone of this conversational query from the
 [time zone database](https://www.iana.org/time-zones), e.g.,
 America/New_York, Europe/Paris. If not provided, the time zone specified in
 agent settings is used.
        string time_zone = 1;
        Specified by:
        getTimeZoneBytes in interface QueryParametersOrBuilder
        Returns:
        The bytes for timeZone.

      • hasGeoLocation

        public boolean hasGeoLocation()
         The geo location of this conversational query.
        .google.type.LatLng geo_location = 2;
        Specified by:
        hasGeoLocation in interface QueryParametersOrBuilder
        Returns:
        Whether the geoLocation field is set.

      • getGeoLocation

        public com.google.type.LatLng getGeoLocation()
         The geo location of this conversational query.
        .google.type.LatLng geo_location = 2;
        Specified by:
        getGeoLocation in interface QueryParametersOrBuilder
        Returns:
        The geoLocation.

      • getGeoLocationOrBuilder

        public com.google.type.LatLngOrBuilder getGeoLocationOrBuilder()
         The geo location of this conversational query.
        .google.type.LatLng geo_location = 2;
        Specified by:
        getGeoLocationOrBuilder in interface QueryParametersOrBuilder

      • 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;
        Specified by:
        getContextsList in interface QueryParametersOrBuilder

      • getContextsCount

        public int getContextsCount()
         The collection of contexts to be activated before this query is
 executed.
        repeated .google.cloud.dialogflow.v2beta1.Context contexts = 3;
        Specified by:
        getContextsCount in interface QueryParametersOrBuilder

      • getContexts

        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;
        Specified by:
        getContexts in interface QueryParametersOrBuilder

      • getResetContexts

        public boolean getResetContexts()
         Specifies whether to delete all contexts in the current session
 before the new ones are activated.
        bool reset_contexts = 4;
        Specified by:
        getResetContexts in interface QueryParametersOrBuilder
        Returns:
        The resetContexts.

      • 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;
        Specified by:
        getSessionEntityTypesList in interface QueryParametersOrBuilder

      • 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;
        Specified by:
        getSessionEntityTypesOrBuilderList in interface QueryParametersOrBuilder

      • 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;
        Specified by:
        getSessionEntityTypesCount in interface QueryParametersOrBuilder

      • getSessionEntityTypes

        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;
        Specified by:
        getSessionEntityTypes in interface QueryParametersOrBuilder

      • getSessionEntityTypesOrBuilder

        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;
        Specified by:
        getSessionEntityTypesOrBuilder in interface QueryParametersOrBuilder

      • 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;
        Specified by:
        hasPayload in interface QueryParametersOrBuilder
        Returns:
        Whether the payload field is set.

      • getPayload

        public 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;
        Specified by:
        getPayload in interface QueryParametersOrBuilder
        Returns:
        The payload.

      • getPayloadOrBuilder

        public com.google.protobuf.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;
        Specified by:
        getPayloadOrBuilder in interface QueryParametersOrBuilder

      • getKnowledgeBaseNamesList

        public com.google.protobuf.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;
        Specified by:
        getKnowledgeBaseNamesList in interface QueryParametersOrBuilder
        Returns:
        A list containing the knowledgeBaseNames.

      • 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;
        Specified by:
        getKnowledgeBaseNamesCount in interface QueryParametersOrBuilder
        Returns:
        The count of knowledgeBaseNames.

      • getKnowledgeBaseNames

        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;
        Specified by:
        getKnowledgeBaseNames in interface QueryParametersOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The knowledgeBaseNames at the given index.

      • getKnowledgeBaseNamesBytes

        public com.google.protobuf.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;
        Specified by:
        getKnowledgeBaseNamesBytes in interface QueryParametersOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the knowledgeBaseNames at the given index.

      • 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;
        Specified by:
        hasSentimentAnalysisRequestConfig in interface QueryParametersOrBuilder
        Returns:
        Whether the sentimentAnalysisRequestConfig field is set.

      • 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;
        Specified by:
        getSentimentAnalysisRequestConfig in interface QueryParametersOrBuilder
        Returns:
        The sentimentAnalysisRequestConfig.

      • 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;
        Specified by:
        getSentimentAnalysisRequestConfigOrBuilder in interface QueryParametersOrBuilder

      • 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;
        Specified by:
        getSubAgentsList in interface QueryParametersOrBuilder

      • 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;
        Specified by:
        getSubAgentsOrBuilderList in interface QueryParametersOrBuilder

      • 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;
        Specified by:
        getSubAgentsCount in interface QueryParametersOrBuilder

      • getSubAgents

        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;
        Specified by:
        getSubAgents in interface QueryParametersOrBuilder

      • getSubAgentsOrBuilder

        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;
        Specified by:
        getSubAgentsOrBuilder in interface QueryParametersOrBuilder

      • getWebhookHeadersCount

        public int getWebhookHeadersCount()
        Description copied from interface: QueryParametersOrBuilder
         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;
        Specified by:
        getWebhookHeadersCount in interface QueryParametersOrBuilder

      • containsWebhookHeaders

        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;
        Specified by:
        containsWebhookHeaders in interface QueryParametersOrBuilder

      • 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;
        Specified by:
        getWebhookHeadersMap in interface QueryParametersOrBuilder

      • getWebhookHeadersOrDefault

        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;
        Specified by:
        getWebhookHeadersOrDefault in interface QueryParametersOrBuilder

      • getWebhookHeadersOrThrow

        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;
        Specified by:
        getWebhookHeadersOrThrow in interface QueryParametersOrBuilder

      • getPlatform

        public 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;
        Specified by:
        getPlatform in interface QueryParametersOrBuilder
        Returns:
        The platform.

      • getPlatformBytes

        public com.google.protobuf.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][google.cloud.dialogflow.v2beta1.Intent.Message.platform].
        string platform = 18;
        Specified by:
        getPlatformBytes in interface QueryParametersOrBuilder
        Returns:
        The bytes for platform.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static QueryParameters parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static QueryParameters parseFrom​(ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static QueryParameters parseFrom​(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static QueryParameters parseFrom​(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static QueryParameters parseFrom​(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static QueryParameters parseFrom​(byte[] data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static QueryParameters parseFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Throws:
        IOException

      • newBuilderForType

        public QueryParameters.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public QueryParameters.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected QueryParameters.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • parser

        public static com.google.protobuf.Parser<QueryParameters> parser()

      • getParserForType

        public com.google.protobuf.Parser<QueryParameters> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public QueryParameters getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder