com.google.cloud.dialogflow.cx.v3.QueryParametersOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-dialogflow-cx-v3 Show documentation
Show all versions of proto-google-cloud-dialogflow-cx-v3 Show documentation
PROTO library for proto-google-cloud-dialogflow-cx-v3
/*
* Copyright 2020 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/cx/v3/session.proto
package com.google.cloud.dialogflow.cx.v3;
public interface QueryParametersOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.cx.v3.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 the agent 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 the agent 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();
/**
*
*
*
* 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.cx.v3.SessionEntityType session_entity_types = 3;
*
*/
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.cx.v3.SessionEntityType session_entity_types = 3;
*
*/
com.google.cloud.dialogflow.cx.v3.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.cx.v3.SessionEntityType session_entity_types = 3;
*
*/
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.cx.v3.SessionEntityType session_entity_types = 3;
*
*/
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.cx.v3.SessionEntityType session_entity_types = 3;
*
*/
com.google.cloud.dialogflow.cx.v3.SessionEntityTypeOrBuilder getSessionEntityTypesOrBuilder(
int index);
/**
*
*
*
* This field can be used to pass custom data into the webhook associated with
* the agent. Arbitrary JSON objects are supported.
* Some integrations that query a Dialogflow agent may provide additional
* information in the payload.
* In particular, for the Dialogflow Phone Gateway integration, this field has
* the form:
* ```
* {
* "telephony": {
* "caller_id": "+18558363987"
* }
* }
* ```
*
*
* .google.protobuf.Struct payload = 4;
*
* @return Whether the payload field is set.
*/
boolean hasPayload();
/**
*
*
*
* This field can be used to pass custom data into the webhook associated with
* the agent. Arbitrary JSON objects are supported.
* Some integrations that query a Dialogflow agent may provide additional
* information in the payload.
* In particular, for the Dialogflow Phone Gateway integration, this field has
* the form:
* ```
* {
* "telephony": {
* "caller_id": "+18558363987"
* }
* }
* ```
*
*
* .google.protobuf.Struct payload = 4;
*
* @return The payload.
*/
com.google.protobuf.Struct getPayload();
/**
*
*
*
* This field can be used to pass custom data into the webhook associated with
* the agent. Arbitrary JSON objects are supported.
* Some integrations that query a Dialogflow agent may provide additional
* information in the payload.
* In particular, for the Dialogflow Phone Gateway integration, this field has
* the form:
* ```
* {
* "telephony": {
* "caller_id": "+18558363987"
* }
* }
* ```
*
*
* .google.protobuf.Struct payload = 4;
*/
com.google.protobuf.StructOrBuilder getPayloadOrBuilder();
/**
*
*
*
* Additional parameters to be put into [session
* parameters][SessionInfo.parameters]. To remove a
* parameter from the session, clients should explicitly set the parameter
* value to null.
* You can reference the session parameters in the agent with the following
* format: $session.params.parameter-id.
* Depending on your protocol or client library language, this is a
* map, associative array, symbol table, dictionary, or JSON object
* composed of a collection of (MapKey, MapValue) pairs:
* - MapKey type: string
* - MapKey value: parameter name
* - MapValue type:
* - If parameter's entity type is a composite entity: map
* - Else: depending on parameter value type, could be one of string,
* number, boolean, null, list or map
* - MapValue value:
* - If parameter's entity type is a composite entity:
* map from composite entity property names to property values
* - Else: parameter value
*
*
* .google.protobuf.Struct parameters = 5;
*
* @return Whether the parameters field is set.
*/
boolean hasParameters();
/**
*
*
*
* Additional parameters to be put into [session
* parameters][SessionInfo.parameters]. To remove a
* parameter from the session, clients should explicitly set the parameter
* value to null.
* You can reference the session parameters in the agent with the following
* format: $session.params.parameter-id.
* Depending on your protocol or client library language, this is a
* map, associative array, symbol table, dictionary, or JSON object
* composed of a collection of (MapKey, MapValue) pairs:
* - MapKey type: string
* - MapKey value: parameter name
* - MapValue type:
* - If parameter's entity type is a composite entity: map
* - Else: depending on parameter value type, could be one of string,
* number, boolean, null, list or map
* - MapValue value:
* - If parameter's entity type is a composite entity:
* map from composite entity property names to property values
* - Else: parameter value
*
*
* .google.protobuf.Struct parameters = 5;
*
* @return The parameters.
*/
com.google.protobuf.Struct getParameters();
/**
*
*
*
* Additional parameters to be put into [session
* parameters][SessionInfo.parameters]. To remove a
* parameter from the session, clients should explicitly set the parameter
* value to null.
* You can reference the session parameters in the agent with the following
* format: $session.params.parameter-id.
* Depending on your protocol or client library language, this is a
* map, associative array, symbol table, dictionary, or JSON object
* composed of a collection of (MapKey, MapValue) pairs:
* - MapKey type: string
* - MapKey value: parameter name
* - MapValue type:
* - If parameter's entity type is a composite entity: map
* - Else: depending on parameter value type, could be one of string,
* number, boolean, null, list or map
* - MapValue value:
* - If parameter's entity type is a composite entity:
* map from composite entity property names to property values
* - Else: parameter value
*
*
* .google.protobuf.Struct parameters = 5;
*/
com.google.protobuf.StructOrBuilder getParametersOrBuilder();
/**
*
*
*
* The unique identifier of the [page][google.cloud.dialogflow.cx.v3.Page] to override the [current
* page][QueryResult.current_page] in the session.
* Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
* ID>/flows/<Flow ID>/pages/<Page ID>`.
* If `current_page` is specified, the previous state of the session will be
* ignored by Dialogflow, including the [previous
* page][QueryResult.current_page] and the [previous session
* parameters][QueryResult.parameters].
* In most cases, [current_page][google.cloud.dialogflow.cx.v3.QueryParameters.current_page] and
* [parameters][google.cloud.dialogflow.cx.v3.QueryParameters.parameters] should be configured together to
* direct a session to a specific state.
*
*
* string current_page = 6 [(.google.api.resource_reference) = { ... }
*
* @return The currentPage.
*/
java.lang.String getCurrentPage();
/**
*
*
*
* The unique identifier of the [page][google.cloud.dialogflow.cx.v3.Page] to override the [current
* page][QueryResult.current_page] in the session.
* Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
* ID>/flows/<Flow ID>/pages/<Page ID>`.
* If `current_page` is specified, the previous state of the session will be
* ignored by Dialogflow, including the [previous
* page][QueryResult.current_page] and the [previous session
* parameters][QueryResult.parameters].
* In most cases, [current_page][google.cloud.dialogflow.cx.v3.QueryParameters.current_page] and
* [parameters][google.cloud.dialogflow.cx.v3.QueryParameters.parameters] should be configured together to
* direct a session to a specific state.
*
*
* string current_page = 6 [(.google.api.resource_reference) = { ... }
*
* @return The bytes for currentPage.
*/
com.google.protobuf.ByteString getCurrentPageBytes();
/**
*
*
*
* Whether to disable webhook calls for this request.
*
*
* bool disable_webhook = 7;
*
* @return The disableWebhook.
*/
boolean getDisableWebhook();
/**
*
*
*
* Configures whether sentiment analysis should be performed. If not
* provided, sentiment analysis is not performed.
*
*
* bool analyze_query_text_sentiment = 8;
*
* @return The analyzeQueryTextSentiment.
*/
boolean getAnalyzeQueryTextSentiment();
/**
*
*
*
* 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 = 10;
*/
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 = 10;
*/
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 = 10;
*/
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 = 10;
*/
java.lang.String getWebhookHeadersOrDefault(java.lang.String key, 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 = 10;
*/
java.lang.String getWebhookHeadersOrThrow(java.lang.String key);
/**
*
*
*
* A list of flow versions to override for the request.
* Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
* ID>/flows/<Flow ID>/versions/<Version ID>`.
* If version 1 of flow X is included in this list, the traffic of
* flow X will go through version 1 regardless of the version configuration in
* the environment. Each flow can have at most one version specified in this
* list.
*
*
* repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }
*
* @return A list containing the flowVersions.
*/
java.util.List getFlowVersionsList();
/**
*
*
*
* A list of flow versions to override for the request.
* Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
* ID>/flows/<Flow ID>/versions/<Version ID>`.
* If version 1 of flow X is included in this list, the traffic of
* flow X will go through version 1 regardless of the version configuration in
* the environment. Each flow can have at most one version specified in this
* list.
*
*
* repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }
*
* @return The count of flowVersions.
*/
int getFlowVersionsCount();
/**
*
*
*
* A list of flow versions to override for the request.
* Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
* ID>/flows/<Flow ID>/versions/<Version ID>`.
* If version 1 of flow X is included in this list, the traffic of
* flow X will go through version 1 regardless of the version configuration in
* the environment. Each flow can have at most one version specified in this
* list.
*
*
* repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }
*
* @param index The index of the element to return.
* @return The flowVersions at the given index.
*/
java.lang.String getFlowVersions(int index);
/**
*
*
*
* A list of flow versions to override for the request.
* Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
* ID>/flows/<Flow ID>/versions/<Version ID>`.
* If version 1 of flow X is included in this list, the traffic of
* flow X will go through version 1 regardless of the version configuration in
* the environment. Each flow can have at most one version specified in this
* list.
*
*
* repeated string flow_versions = 14 [(.google.api.resource_reference) = { ... }
*
* @param index The index of the value to return.
* @return The bytes of the flowVersions at the given index.
*/
com.google.protobuf.ByteString getFlowVersionsBytes(int index);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy