public final class QueryParameters extends GeneratedMessageV3 implements QueryParametersOrBuilder
Represents the parameters of a conversational query.
Protobuf type google.cloud.dialogflow.cx.v3.QueryParameters
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
ANALYZE_QUERY_TEXT_SENTIMENT_FIELD_NUMBER
public static final int ANALYZE_QUERY_TEXT_SENTIMENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CHANNEL_FIELD_NUMBER
public static final int CHANNEL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CURRENT_PAGE_FIELD_NUMBER
public static final int CURRENT_PAGE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISABLE_WEBHOOK_FIELD_NUMBER
public static final int DISABLE_WEBHOOK_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FLOW_VERSIONS_FIELD_NUMBER
public static final int FLOW_VERSIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GEO_LOCATION_FIELD_NUMBER
public static final int GEO_LOCATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARAMETERS_FIELD_NUMBER
public static final int PARAMETERS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAYLOAD_FIELD_NUMBER
public static final int PAYLOAD_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SESSION_ENTITY_TYPES_FIELD_NUMBER
public static final int SESSION_ENTITY_TYPES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TIME_ZONE_FIELD_NUMBER
public static final int TIME_ZONE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int WEBHOOK_HEADERS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static QueryParameters getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static QueryParameters.Builder newBuilder()
newBuilder(QueryParameters prototype)
public static QueryParameters.Builder newBuilder(QueryParameters prototype)
public static QueryParameters parseDelimitedFrom(InputStream input)
public static QueryParameters parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static QueryParameters parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static QueryParameters parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static QueryParameters parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static QueryParameters parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static QueryParameters parseFrom(CodedInputStream input)
public static QueryParameters parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static QueryParameters parseFrom(InputStream input)
public static QueryParameters parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static QueryParameters parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static QueryParameters parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<QueryParameters> parser()
Methods
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 = 10;
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAnalyzeQueryTextSentiment()
public boolean getAnalyzeQueryTextSentiment()
Configures whether sentiment analysis should be performed. If not
provided, sentiment analysis is not performed.
bool analyze_query_text_sentiment = 8;
| Returns |
| Type |
Description |
boolean |
The analyzeQueryTextSentiment.
|
getChannel()
public String getChannel()
The channel which this query is for.
If specified, only the
ResponseMessage associated
with the channel will be returned. If no
ResponseMessage is
associated with the channel, it falls back to the
ResponseMessage with
unspecified channel.
If unspecified, the
ResponseMessage with
unspecified channel will be returned.
string channel = 15;
| Returns |
| Type |
Description |
String |
The channel.
|
getChannelBytes()
public ByteString getChannelBytes()
The channel which this query is for.
If specified, only the
ResponseMessage associated
with the channel will be returned. If no
ResponseMessage is
associated with the channel, it falls back to the
ResponseMessage with
unspecified channel.
If unspecified, the
ResponseMessage with
unspecified channel will be returned.
string channel = 15;
| Returns |
| Type |
Description |
ByteString |
The bytes for channel.
|
getCurrentPage()
public String getCurrentPage()
The unique identifier of the page to
override the 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 and the previous session
parameters.
In most cases,
current_page
and parameters
should be configured together to direct a session to a specific state.
string current_page = 6 [(.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The currentPage.
|
getCurrentPageBytes()
public ByteString getCurrentPageBytes()
The unique identifier of the page to
override the 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 and the previous session
parameters.
In most cases,
current_page
and parameters
should be configured together to direct a session to a specific state.
string current_page = 6 [(.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for currentPage.
|
getDefaultInstanceForType()
public QueryParameters getDefaultInstanceForType()
getDisableWebhook()
public boolean getDisableWebhook()
Whether to disable webhook calls for this request.
bool disable_webhook = 7;
| Returns |
| Type |
Description |
boolean |
The disableWebhook.
|
getFlowVersions(int index)
public 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) = { ... }
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The flowVersions at the given index.
|
getFlowVersionsBytes(int index)
public ByteString getFlowVersionsBytes(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) = { ... }
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the flowVersions at the given index.
|
getFlowVersionsCount()
public 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) = { ... }
| Returns |
| Type |
Description |
int |
The count of flowVersions.
|
getFlowVersionsList()
public ProtocolStringList 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) = { ... }
getGeoLocation()
public LatLng getGeoLocation()
The geo location of this conversational query.
.google.type.LatLng geo_location = 2;
| Returns |
| Type |
Description |
com.google.type.LatLng |
The geoLocation.
|
getGeoLocationOrBuilder()
public LatLngOrBuilder getGeoLocationOrBuilder()
The geo location of this conversational query.
.google.type.LatLng geo_location = 2;
| Returns |
| Type |
Description |
com.google.type.LatLngOrBuilder |
|
getParameters()
public Struct getParameters()
Additional parameters to be put into session
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;
| Returns |
| Type |
Description |
Struct |
The parameters.
|
getParametersOrBuilder()
public StructOrBuilder getParametersOrBuilder()
Additional parameters to be put into session
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;
getParserForType()
public Parser<QueryParameters> getParserForType()
Overrides
getPayload()
public 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:
<code><code>
{
"telephony": {
"caller_id": "+18558363987"
}
}
</code></code>
.google.protobuf.Struct payload = 4;
| Returns |
| Type |
Description |
Struct |
The payload.
|
getPayloadOrBuilder()
public 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:
<code><code>
{
"telephony": {
"caller_id": "+18558363987"
}
}
</code></code>
.google.protobuf.Struct payload = 4;
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSessionEntityTypes(int index)
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.cx.v3.SessionEntityType session_entity_types = 3;
| Parameter |
| Name |
Description |
index |
int
|
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.cx.v3.SessionEntityType session_entity_types = 3;
| Returns |
| Type |
Description |
int |
|
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.cx.v3.SessionEntityType session_entity_types = 3;
getSessionEntityTypesOrBuilder(int index)
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.cx.v3.SessionEntityType session_entity_types = 3;
| Parameter |
| Name |
Description |
index |
int
|
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.cx.v3.SessionEntityType session_entity_types = 3;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.dialogflow.cx.v3.SessionEntityTypeOrBuilder> |
|
getTimeZone()
public String getTimeZone()
The time zone of this conversational query from the time zone
database, e.g., America/New_York,
Europe/Paris. If not provided, the time zone specified in the agent is
used.
string time_zone = 1;
| Returns |
| Type |
Description |
String |
The timeZone.
|
getTimeZoneBytes()
public ByteString getTimeZoneBytes()
The time zone of this conversational query from the time zone
database, e.g., America/New_York,
Europe/Paris. If not provided, the time zone specified in the agent is
used.
string time_zone = 1;
| Returns |
| Type |
Description |
ByteString |
The bytes for timeZone.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
public Map<String,String> getWebhookHeaders()
public 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;
| Returns |
| Type |
Description |
int |
|
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 = 10;
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 = 10;
| Returns |
| Type |
Description |
String |
|
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 = 10;
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
hasGeoLocation()
public boolean hasGeoLocation()
The geo location of this conversational query.
.google.type.LatLng geo_location = 2;
| Returns |
| Type |
Description |
boolean |
Whether the geoLocation field is set.
|
hasParameters()
public boolean hasParameters()
Additional parameters to be put into session
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;
| Returns |
| Type |
Description |
boolean |
Whether the parameters field is set.
|
hasPayload()
public 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:
<code><code>
{
"telephony": {
"caller_id": "+18558363987"
}
}
</code></code>
.google.protobuf.Struct payload = 4;
| Returns |
| Type |
Description |
boolean |
Whether the payload field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
| Name |
Description |
number |
int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public QueryParameters.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected QueryParameters.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public QueryParameters.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
