Class QueryParameters (4.27.0)

public final class QueryParameters extends GeneratedMessageV3 implements QueryParametersOrBuilder

Represents the parameters of the conversational query.

Protobuf type google.cloud.dialogflow.v2.QueryParameters

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

PAYLOAD_FIELD_NUMBER

public static final int PAYLOAD_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

TIME_ZONE_FIELD_NUMBER

public static final int TIME_ZONE_FIELD_NUMBER
Field Value
Type Description
int

WEBHOOK_HEADERS_FIELD_NUMBER

public static final int WEBHOOK_HEADERS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static QueryParameters getDefaultInstance()
Returns
Type Description
QueryParameters

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static QueryParameters.Builder newBuilder()
Returns
Type Description
QueryParameters.Builder

newBuilder(QueryParameters prototype)

public static QueryParameters.Builder newBuilder(QueryParameters prototype)
Parameter
Name Description
prototype QueryParameters
Returns
Type Description
QueryParameters.Builder

parseDelimitedFrom(InputStream input)

public static QueryParameters parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
QueryParameters
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryParameters parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryParameters
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static QueryParameters parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
QueryParameters
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static QueryParameters parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryParameters
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static QueryParameters parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
QueryParameters
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static QueryParameters parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryParameters
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static QueryParameters parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
QueryParameters
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryParameters parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryParameters
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static QueryParameters parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
QueryParameters
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryParameters parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryParameters
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static QueryParameters parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
QueryParameters
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static QueryParameters parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryParameters
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<QueryParameters> parser()
Returns
Type Description
Parser<QueryParameters>

Methods

containsWebhookHeaders(String key)

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 the Dialogflow web console. The headers defined within this field will overwrite the headers configured through the 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
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.v2.Context contexts = 3;

Parameter
Name Description
index int
Returns
Type Description
Context

getContextsCount()

public int getContextsCount()

The collection of contexts to be activated before this query is executed.

repeated .google.cloud.dialogflow.v2.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.v2.Context contexts = 3;

Returns
Type Description
List<Context>

getContextsOrBuilder(int index)

public ContextOrBuilder getContextsOrBuilder(int index)

The collection of contexts to be activated before this query is executed.

repeated .google.cloud.dialogflow.v2.Context contexts = 3;

Parameter
Name Description
index int
Returns
Type Description
ContextOrBuilder

getContextsOrBuilderList()

public List<? extends ContextOrBuilder> getContextsOrBuilderList()

The collection of contexts to be activated before this query is executed.

repeated .google.cloud.dialogflow.v2.Context contexts = 3;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.v2.ContextOrBuilder>

getDefaultInstanceForType()

public QueryParameters getDefaultInstanceForType()
Returns
Type Description
QueryParameters

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

getParserForType()

public Parser<QueryParameters> getParserForType()
Returns
Type Description
Parser<QueryParameters>
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;

Returns
Type Description
StructOrBuilder

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.

.google.cloud.dialogflow.v2.SentimentAnalysisRequestConfig sentiment_analysis_request_config = 10;

Returns
Type Description
SentimentAnalysisRequestConfig

The sentimentAnalysisRequestConfig.

getSentimentAnalysisRequestConfigOrBuilder()

public SentimentAnalysisRequestConfigOrBuilder getSentimentAnalysisRequestConfigOrBuilder()

Configures the type of sentiment analysis to perform. If not provided, sentiment analysis is not performed.

.google.cloud.dialogflow.v2.SentimentAnalysisRequestConfig sentiment_analysis_request_config = 10;

Returns
Type Description
SentimentAnalysisRequestConfigOrBuilder

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.v2.SessionEntityType session_entity_types = 5;

Parameter
Name Description
index int
Returns
Type Description
SessionEntityType

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.v2.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.v2.SessionEntityType session_entity_types = 5;

Returns
Type Description
List<SessionEntityType>

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.v2.SessionEntityType session_entity_types = 5;

Parameter
Name Description
index int
Returns
Type Description
SessionEntityTypeOrBuilder

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.v2.SessionEntityType session_entity_types = 5;

Returns
Type Description
List<? extends com.google.cloud.dialogflow.v2.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 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.

getWebhookHeaders()

public Map<String,String> getWebhookHeaders()
Returns
Type Description
Map<String,String>

getWebhookHeadersCount()

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 the Dialogflow web console. The headers defined within this field will overwrite the headers configured through the 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

getWebhookHeadersMap()

public Map<String,String> getWebhookHeadersMap()

This field can be used to pass HTTP headers for a webhook call. These headers will be sent to webhook along with the headers that have been configured through the Dialogflow web console. The headers defined within this field will overwrite the headers configured through the 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
Map<String,String>

getWebhookHeadersOrDefault(String key, String defaultValue)

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 the Dialogflow web console. The headers defined within this field will overwrite the headers configured through the 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;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getWebhookHeadersOrThrow(String key)

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 the Dialogflow web console. The headers defined within this field will overwrite the headers configured through the 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.

.google.cloud.dialogflow.v2.SentimentAnalysisRequestConfig sentiment_analysis_request_config = 10;

Returns
Type Description
boolean

Whether the sentimentAnalysisRequestConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public QueryParameters.Builder newBuilderForType()
Returns
Type Description
QueryParameters.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected QueryParameters.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
QueryParameters.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public QueryParameters.Builder toBuilder()
Returns
Type Description
QueryParameters.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException