public final class QueryParameters extends GeneratedMessageV3 implements QueryParametersOrBuilder
Represents the parameters of the conversational query.
Protobuf type google.cloud.dialogflow.v2beta1.QueryParameters
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CONTEXTS_FIELD_NUMBER
public static final int CONTEXTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GEO_LOCATION_FIELD_NUMBER
public static final int GEO_LOCATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
KNOWLEDGE_BASE_NAMES_FIELD_NUMBER
public static final int KNOWLEDGE_BASE_NAMES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAYLOAD_FIELD_NUMBER
public static final int PAYLOAD_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PLATFORM_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESET_CONTEXTS_FIELD_NUMBER
public static final int RESET_CONTEXTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SENTIMENT_ANALYSIS_REQUEST_CONFIG_FIELD_NUMBER
public static final int SENTIMENT_ANALYSIS_REQUEST_CONFIG_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 |
|
SUB_AGENTS_FIELD_NUMBER
public static final int SUB_AGENTS_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 = 14;
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getContexts(int index)
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;
| Parameter |
| Name |
Description |
index |
int
|
getContextsCount()
public int getContextsCount()
The collection of contexts to be activated before this query is
executed.
repeated .google.cloud.dialogflow.v2beta1.Context contexts = 3;
| Returns |
| Type |
Description |
int |
|
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;
getContextsOrBuilder(int index)
public ContextOrBuilder getContextsOrBuilder(int index)
The collection of contexts to be activated before this query is
executed.
repeated .google.cloud.dialogflow.v2beta1.Context contexts = 3;
| Parameter |
| Name |
Description |
index |
int
|
getContextsOrBuilderList()
public List<? extends ContextOrBuilder> getContextsOrBuilderList()
The collection of contexts to be activated before this query is
executed.
repeated .google.cloud.dialogflow.v2beta1.Context contexts = 3;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.dialogflow.v2beta1.ContextOrBuilder> |
|
getDefaultInstanceForType()
public QueryParameters getDefaultInstanceForType()
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 |
|
getKnowledgeBaseNames(int index)
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;
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The knowledgeBaseNames at the given index.
|
getKnowledgeBaseNamesBytes(int index)
public 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;
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the knowledgeBaseNames at the given index.
|
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;
| Returns |
| Type |
Description |
int |
The count of knowledgeBaseNames.
|
getKnowledgeBaseNamesList()
public 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;
getParserForType()
public Parser<QueryParameters> getParserForType()
Overrides
getPayload()
public 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;
| Returns |
| Type |
Description |
Struct |
The payload.
|
getPayloadOrBuilder()
public 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;
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.
string platform = 18;
| Returns |
| Type |
Description |
String |
The platform.
|
public 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.
string platform = 18;
| Returns |
| Type |
Description |
ByteString |
The bytes for platform.
|
getResetContexts()
public boolean getResetContexts()
Specifies whether to delete all contexts in the current session
before the new ones are activated.
bool reset_contexts = 4;
| Returns |
| Type |
Description |
boolean |
The resetContexts.
|
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;
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;
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.v2beta1.SessionEntityType session_entity_types = 5;
| 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.v2beta1.SessionEntityType session_entity_types = 5;
| 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.v2beta1.SessionEntityType session_entity_types = 5;
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.v2beta1.SessionEntityType session_entity_types = 5;
| 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.v2beta1.SessionEntityType session_entity_types = 5;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.dialogflow.v2beta1.SessionEntityTypeOrBuilder> |
|
getSubAgents(int index)
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;
| Parameter |
| Name |
Description |
index |
int
|
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;
| Returns |
| Type |
Description |
int |
|
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;
getSubAgentsOrBuilder(int index)
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;
| Parameter |
| Name |
Description |
index |
int
|
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;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.dialogflow.v2beta1.SubAgentOrBuilder> |
|
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
agent settings 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
agent settings is used.
string time_zone = 1;
| Returns |
| Type |
Description |
ByteString |
The bytes for timeZone.
|
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 = 14;
| 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 = 14;
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;
| 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 = 14;
| 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.
|
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;
| Returns |
| Type |
Description |
boolean |
Whether the payload field is set.
|
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;
| Returns |
| Type |
Description |
boolean |
Whether the sentimentAnalysisRequestConfig field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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
