public final class QueryParameters extends com.google.protobuf.GeneratedMessageV3 implements QueryParametersOrBuilder
Represents the parameters of a conversational query.Protobuf type
google.cloud.dialogflow.cx.v3.QueryParameters| Modifier and Type | Class and Description |
|---|---|
static class |
QueryParameters.Builder
Represents the parameters of a conversational query.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
ANALYZE_QUERY_TEXT_SENTIMENT_FIELD_NUMBER |
static int |
CHANNEL_FIELD_NUMBER |
static int |
CURRENT_PAGE_FIELD_NUMBER |
static int |
DISABLE_WEBHOOK_FIELD_NUMBER |
static int |
END_USER_METADATA_FIELD_NUMBER |
static int |
FLOW_VERSIONS_FIELD_NUMBER |
static int |
GEO_LOCATION_FIELD_NUMBER |
static int |
PARAMETERS_FIELD_NUMBER |
static int |
PAYLOAD_FIELD_NUMBER |
static int |
POPULATE_DATA_STORE_CONNECTION_SIGNALS_FIELD_NUMBER |
static int |
SEARCH_CONFIG_FIELD_NUMBER |
static int |
SESSION_ENTITY_TYPES_FIELD_NUMBER |
static int |
SESSION_TTL_FIELD_NUMBER |
static int |
TIME_ZONE_FIELD_NUMBER |
static int |
WEBHOOK_HEADERS_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsWebhookHeaders(String key)
This field can be used to pass HTTP headers for a webhook
call.
|
boolean |
equals(Object obj) |
boolean |
getAnalyzeQueryTextSentiment()
Configures whether sentiment analysis should be performed.
|
String |
getChannel()
The channel which this query is for.
|
com.google.protobuf.ByteString |
getChannelBytes()
The channel which this query is for.
|
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.
|
com.google.protobuf.ByteString |
getCurrentPageBytes()
The unique identifier of the [page][google.cloud.dialogflow.cx.v3.Page] to
override the [current page][QueryResult.current_page] in the session.
|
static QueryParameters |
getDefaultInstance() |
QueryParameters |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
boolean |
getDisableWebhook()
Whether to disable webhook calls for this request.
|
com.google.protobuf.Struct |
getEndUserMetadata()
Optional.
|
com.google.protobuf.StructOrBuilder |
getEndUserMetadataOrBuilder()
Optional.
|
String |
getFlowVersions(int index)
A list of flow versions to override for the request.
|
com.google.protobuf.ByteString |
getFlowVersionsBytes(int index)
A list of flow versions to override for the request.
|
int |
getFlowVersionsCount()
A list of flow versions to override for the request.
|
com.google.protobuf.ProtocolStringList |
getFlowVersionsList()
A list of flow versions to override for the request.
|
com.google.type.LatLng |
getGeoLocation()
The geo location of this conversational query.
|
com.google.type.LatLngOrBuilder |
getGeoLocationOrBuilder()
The geo location of this conversational query.
|
com.google.protobuf.Struct |
getParameters()
Additional parameters to be put into [session
parameters][SessionInfo.parameters].
|
com.google.protobuf.StructOrBuilder |
getParametersOrBuilder()
Additional parameters to be put into [session
parameters][SessionInfo.parameters].
|
com.google.protobuf.Parser<QueryParameters> |
getParserForType() |
com.google.protobuf.Struct |
getPayload()
This field can be used to pass custom data into the webhook associated with
the agent.
|
com.google.protobuf.StructOrBuilder |
getPayloadOrBuilder()
This field can be used to pass custom data into the webhook associated with
the agent.
|
boolean |
getPopulateDataStoreConnectionSignals()
Deprecated.
google.cloud.dialogflow.cx.v3.QueryParameters.populate_data_store_connection_signals is
deprecated. See google/cloud/dialogflow/cx/v3/session.proto;l=730
|
SearchConfig |
getSearchConfig()
Optional.
|
SearchConfigOrBuilder |
getSearchConfigOrBuilder()
Optional.
|
int |
getSerializedSize() |
SessionEntityType |
getSessionEntityTypes(int index)
Additional session entity types to replace or extend developer entity types
with.
|
int |
getSessionEntityTypesCount()
Additional session entity types to replace or extend developer entity types
with.
|
List<SessionEntityType> |
getSessionEntityTypesList()
Additional session entity types to replace or extend developer entity types
with.
|
SessionEntityTypeOrBuilder |
getSessionEntityTypesOrBuilder(int index)
Additional session entity types to replace or extend developer entity types
with.
|
List<? extends SessionEntityTypeOrBuilder> |
getSessionEntityTypesOrBuilderList()
Additional session entity types to replace or extend developer entity types
with.
|
com.google.protobuf.Duration |
getSessionTtl()
Optional.
|
com.google.protobuf.DurationOrBuilder |
getSessionTtlOrBuilder()
Optional.
|
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.
|
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.
|
Map<String,String> |
getWebhookHeaders()
Deprecated.
|
int |
getWebhookHeadersCount()
This field can be used to pass HTTP headers for a webhook
call.
|
Map<String,String> |
getWebhookHeadersMap()
This field can be used to pass HTTP headers for a webhook
call.
|
String |
getWebhookHeadersOrDefault(String key,
String defaultValue)
This field can be used to pass HTTP headers for a webhook
call.
|
String |
getWebhookHeadersOrThrow(String key)
This field can be used to pass HTTP headers for a webhook
call.
|
boolean |
hasEndUserMetadata()
Optional.
|
boolean |
hasGeoLocation()
The geo location of this conversational query.
|
int |
hashCode() |
boolean |
hasParameters()
Additional parameters to be put into [session
parameters][SessionInfo.parameters].
|
boolean |
hasPayload()
This field can be used to pass custom data into the webhook associated with
the agent.
|
boolean |
hasSearchConfig()
Optional.
|
boolean |
hasSessionTtl()
Optional.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMapFieldReflection(int number) |
boolean |
isInitialized() |
static QueryParameters.Builder |
newBuilder() |
static QueryParameters.Builder |
newBuilder(QueryParameters prototype) |
QueryParameters.Builder |
newBuilderForType() |
protected QueryParameters.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static QueryParameters |
parseDelimitedFrom(InputStream input) |
static QueryParameters |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static QueryParameters |
parseFrom(byte[] data) |
static QueryParameters |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static QueryParameters |
parseFrom(ByteBuffer data) |
static QueryParameters |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static QueryParameters |
parseFrom(com.google.protobuf.ByteString data) |
static QueryParameters |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static QueryParameters |
parseFrom(com.google.protobuf.CodedInputStream input) |
static QueryParameters |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static QueryParameters |
parseFrom(InputStream input) |
static QueryParameters |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<QueryParameters> |
parser() |
QueryParameters.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int TIME_ZONE_FIELD_NUMBER
public static final int GEO_LOCATION_FIELD_NUMBER
public static final int SESSION_ENTITY_TYPES_FIELD_NUMBER
public static final int PAYLOAD_FIELD_NUMBER
public static final int PARAMETERS_FIELD_NUMBER
public static final int CURRENT_PAGE_FIELD_NUMBER
public static final int DISABLE_WEBHOOK_FIELD_NUMBER
public static final int ANALYZE_QUERY_TEXT_SENTIMENT_FIELD_NUMBER
public static final int WEBHOOK_HEADERS_FIELD_NUMBER
public static final int FLOW_VERSIONS_FIELD_NUMBER
public static final int CHANNEL_FIELD_NUMBER
public static final int SESSION_TTL_FIELD_NUMBER
public static final int END_USER_METADATA_FIELD_NUMBER
public static final int SEARCH_CONFIG_FIELD_NUMBER
public static final int POPULATE_DATA_STORE_CONNECTION_SIGNALS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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;getTimeZone in interface QueryParametersOrBuilderpublic 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 the agent is used.
string time_zone = 1;getTimeZoneBytes in interface QueryParametersOrBuilderpublic boolean hasGeoLocation()
The geo location of this conversational query.
.google.type.LatLng geo_location = 2;hasGeoLocation in interface QueryParametersOrBuilderpublic com.google.type.LatLng getGeoLocation()
The geo location of this conversational query.
.google.type.LatLng geo_location = 2;getGeoLocation in interface QueryParametersOrBuilderpublic com.google.type.LatLngOrBuilder getGeoLocationOrBuilder()
The geo location of this conversational query.
.google.type.LatLng geo_location = 2;getGeoLocationOrBuilder in interface QueryParametersOrBuilderpublic 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.cx.v3.SessionEntityType session_entity_types = 3;
getSessionEntityTypesList in interface QueryParametersOrBuilderpublic 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.cx.v3.SessionEntityType session_entity_types = 3;
getSessionEntityTypesOrBuilderList in interface QueryParametersOrBuilderpublic 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;
getSessionEntityTypesCount in interface QueryParametersOrBuilderpublic 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;
getSessionEntityTypes in interface QueryParametersOrBuilderpublic 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.cx.v3.SessionEntityType session_entity_types = 3;
getSessionEntityTypesOrBuilder in interface QueryParametersOrBuilderpublic 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;hasPayload in interface QueryParametersOrBuilderpublic 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;getPayload in interface QueryParametersOrBuilderpublic com.google.protobuf.StructOrBuilder getPayloadOrBuilder()
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;getPayloadOrBuilder in interface QueryParametersOrBuilderpublic 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.
.google.protobuf.Struct parameters = 5;hasParameters in interface QueryParametersOrBuilderpublic 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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.
.google.protobuf.Struct parameters = 5;getParameters in interface QueryParametersOrBuilderpublic com.google.protobuf.StructOrBuilder getParametersOrBuilder()
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 then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map. * MapValue value: If parameter's entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.
.google.protobuf.Struct parameters = 5;getParametersOrBuilder in interface QueryParametersOrBuilderpublic 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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`. 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) = { ... }getCurrentPage in interface QueryParametersOrBuilderpublic com.google.protobuf.ByteString getCurrentPageBytes()
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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>`. 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) = { ... }getCurrentPageBytes in interface QueryParametersOrBuilderpublic boolean getDisableWebhook()
Whether to disable webhook calls for this request.
bool disable_webhook = 7;getDisableWebhook in interface QueryParametersOrBuilderpublic boolean getAnalyzeQueryTextSentiment()
Configures whether sentiment analysis should be performed. If not provided, sentiment analysis is not performed.
bool analyze_query_text_sentiment = 8;getAnalyzeQueryTextSentiment in interface QueryParametersOrBuilderpublic int getWebhookHeadersCount()
QueryParametersOrBuilderThis 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;getWebhookHeadersCount in interface QueryParametersOrBuilderpublic 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 = 10;containsWebhookHeaders in interface QueryParametersOrBuilder@Deprecated public Map<String,String> getWebhookHeaders()
getWebhookHeadersMap() instead.getWebhookHeaders in interface QueryParametersOrBuilderpublic 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 = 10;getWebhookHeadersMap in interface QueryParametersOrBuilderpublic 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 = 10;getWebhookHeadersOrDefault in interface QueryParametersOrBuilderpublic 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 = 10;getWebhookHeadersOrThrow in interface QueryParametersOrBuilderpublic com.google.protobuf.ProtocolStringList getFlowVersionsList()
A list of flow versions to override for the request. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`. 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) = { ... }getFlowVersionsList in interface QueryParametersOrBuilderpublic int getFlowVersionsCount()
A list of flow versions to override for the request. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`. 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) = { ... }getFlowVersionsCount in interface QueryParametersOrBuilderpublic String getFlowVersions(int index)
A list of flow versions to override for the request. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`. 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) = { ... }getFlowVersions in interface QueryParametersOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getFlowVersionsBytes(int index)
A list of flow versions to override for the request. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>`. 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) = { ... }getFlowVersionsBytes in interface QueryParametersOrBuilderindex - The index of the value to return.public String getChannel()
The channel which this query is for. If specified, only the [ResponseMessage][google.cloud.dialogflow.cx.v3.ResponseMessage] associated with the channel will be returned. If no [ResponseMessage][google.cloud.dialogflow.cx.v3.ResponseMessage] is associated with the channel, it falls back to the [ResponseMessage][google.cloud.dialogflow.cx.v3.ResponseMessage] with unspecified channel. If unspecified, the [ResponseMessage][google.cloud.dialogflow.cx.v3.ResponseMessage] with unspecified channel will be returned.
string channel = 15;getChannel in interface QueryParametersOrBuilderpublic com.google.protobuf.ByteString getChannelBytes()
The channel which this query is for. If specified, only the [ResponseMessage][google.cloud.dialogflow.cx.v3.ResponseMessage] associated with the channel will be returned. If no [ResponseMessage][google.cloud.dialogflow.cx.v3.ResponseMessage] is associated with the channel, it falls back to the [ResponseMessage][google.cloud.dialogflow.cx.v3.ResponseMessage] with unspecified channel. If unspecified, the [ResponseMessage][google.cloud.dialogflow.cx.v3.ResponseMessage] with unspecified channel will be returned.
string channel = 15;getChannelBytes in interface QueryParametersOrBuilderpublic boolean hasSessionTtl()
Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.
.google.protobuf.Duration session_ttl = 16 [(.google.api.field_behavior) = OPTIONAL];
hasSessionTtl in interface QueryParametersOrBuilderpublic com.google.protobuf.Duration getSessionTtl()
Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.
.google.protobuf.Duration session_ttl = 16 [(.google.api.field_behavior) = OPTIONAL];
getSessionTtl in interface QueryParametersOrBuilderpublic com.google.protobuf.DurationOrBuilder getSessionTtlOrBuilder()
Optional. Configure lifetime of the Dialogflow session. By default, a Dialogflow session remains active and its data is stored for 30 minutes after the last request is sent for the session. This value should be no longer than 1 day.
.google.protobuf.Duration session_ttl = 16 [(.google.api.field_behavior) = OPTIONAL];
getSessionTtlOrBuilder in interface QueryParametersOrBuilderpublic boolean hasEndUserMetadata()
Optional. Information about the end-user to improve the relevance and
accuracy of generative answers.
This will be interpreted and used by a language model, so, for good
results, the data should be self-descriptive, and in a simple structure.
Example:
```json
{
"subscription plan": "Business Premium Plus",
"devices owned": [
{"model": "Google Pixel 7"},
{"model": "Google Pixel Tablet"}
]
}
```
.google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];
hasEndUserMetadata in interface QueryParametersOrBuilderpublic com.google.protobuf.Struct getEndUserMetadata()
Optional. Information about the end-user to improve the relevance and
accuracy of generative answers.
This will be interpreted and used by a language model, so, for good
results, the data should be self-descriptive, and in a simple structure.
Example:
```json
{
"subscription plan": "Business Premium Plus",
"devices owned": [
{"model": "Google Pixel 7"},
{"model": "Google Pixel Tablet"}
]
}
```
.google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];
getEndUserMetadata in interface QueryParametersOrBuilderpublic com.google.protobuf.StructOrBuilder getEndUserMetadataOrBuilder()
Optional. Information about the end-user to improve the relevance and
accuracy of generative answers.
This will be interpreted and used by a language model, so, for good
results, the data should be self-descriptive, and in a simple structure.
Example:
```json
{
"subscription plan": "Business Premium Plus",
"devices owned": [
{"model": "Google Pixel 7"},
{"model": "Google Pixel Tablet"}
]
}
```
.google.protobuf.Struct end_user_metadata = 18 [(.google.api.field_behavior) = OPTIONAL];
getEndUserMetadataOrBuilder in interface QueryParametersOrBuilderpublic boolean hasSearchConfig()
Optional. Search configuration for UCS search queries.
.google.cloud.dialogflow.cx.v3.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];
hasSearchConfig in interface QueryParametersOrBuilderpublic SearchConfig getSearchConfig()
Optional. Search configuration for UCS search queries.
.google.cloud.dialogflow.cx.v3.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];
getSearchConfig in interface QueryParametersOrBuilderpublic SearchConfigOrBuilder getSearchConfigOrBuilder()
Optional. Search configuration for UCS search queries.
.google.cloud.dialogflow.cx.v3.SearchConfig search_config = 20 [(.google.api.field_behavior) = OPTIONAL];
getSearchConfigOrBuilder in interface QueryParametersOrBuilder@Deprecated public boolean getPopulateDataStoreConnectionSignals()
Optional. If set to true and data stores are involved in serving the request then DetectIntentResponse.query_result.data_store_connection_signals will be filled with data that can help evaluations.
bool populate_data_store_connection_signals = 25 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
getPopulateDataStoreConnectionSignals in interface QueryParametersOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static QueryParameters parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static QueryParameters parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static QueryParameters parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static QueryParameters parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static QueryParameters parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static QueryParameters parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static QueryParameters parseFrom(InputStream input) throws IOException
IOExceptionpublic static QueryParameters parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static QueryParameters parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static QueryParameters parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static QueryParameters parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static QueryParameters parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic QueryParameters.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static QueryParameters.Builder newBuilder()
public static QueryParameters.Builder newBuilder(QueryParameters prototype)
public QueryParameters.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected QueryParameters.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static QueryParameters getDefaultInstance()
public static com.google.protobuf.Parser<QueryParameters> parser()
public com.google.protobuf.Parser<QueryParameters> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public QueryParameters getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2025 Google LLC. All rights reserved.