com.google.cloud.discoveryengine.v1beta

Class AnswerQueryRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1beta.AnswerQueryRequest

All Implemented Interfaces:

AnswerQueryRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class AnswerQueryRequest
extends com.google.protobuf.GeneratedMessageV3
implements AnswerQueryRequestOrBuilder

 Request message for
 [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1beta.ConversationalSearchService.AnswerQuery]
 method.
 

Protobuf type google.cloud.discoveryengine.v1beta.AnswerQueryRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnswerQueryRequest.AnswerGenerationSpec Answer generation specification.
static interface	AnswerQueryRequest.AnswerGenerationSpecOrBuilder
static class	AnswerQueryRequest.Builder Request message for [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1beta.ConversationalSearchService.AnswerQuery] method.
static class	AnswerQueryRequest.GroundingSpec Grounding specification.
static interface	AnswerQueryRequest.GroundingSpecOrBuilder
static class	AnswerQueryRequest.QueryUnderstandingSpec Query understanding specification.
static interface	AnswerQueryRequest.QueryUnderstandingSpecOrBuilder
static class	AnswerQueryRequest.RelatedQuestionsSpec Related questions specification.
static interface	AnswerQueryRequest.RelatedQuestionsSpecOrBuilder
static class	AnswerQueryRequest.SafetySpec Safety specification.
static interface	AnswerQueryRequest.SafetySpecOrBuilder
static class	AnswerQueryRequest.SearchSpec Search specification.
static interface	AnswerQueryRequest.SearchSpecOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

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

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANSWER_GENERATION_SPEC_FIELD_NUMBER
static int	ASYNCHRONOUS_MODE_FIELD_NUMBER
static int	GROUNDING_SPEC_FIELD_NUMBER
static int	QUERY_FIELD_NUMBER
static int	QUERY_UNDERSTANDING_SPEC_FIELD_NUMBER
static int	RELATED_QUESTIONS_SPEC_FIELD_NUMBER
static int	SAFETY_SPEC_FIELD_NUMBER
static int	SEARCH_SPEC_FIELD_NUMBER
static int	SERVING_CONFIG_FIELD_NUMBER
static int	SESSION_FIELD_NUMBER
static int	USER_LABELS_FIELD_NUMBER
static int	USER_PSEUDO_ID_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsUserLabels(String key) The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
boolean	equals(Object obj)
AnswerQueryRequest.AnswerGenerationSpec	getAnswerGenerationSpec() Answer generation specification.
AnswerQueryRequest.AnswerGenerationSpecOrBuilder	getAnswerGenerationSpecOrBuilder() Answer generation specification.
boolean	getAsynchronousMode() Deprecated. google.cloud.discoveryengine.v1beta.AnswerQueryRequest.asynchronous_mode is deprecated. See google/cloud/discoveryengine/v1beta/conversational_search_service.proto;l=861
static AnswerQueryRequest	getDefaultInstance()
AnswerQueryRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
AnswerQueryRequest.GroundingSpec	getGroundingSpec() Optional.
AnswerQueryRequest.GroundingSpecOrBuilder	getGroundingSpecOrBuilder() Optional.
com.google.protobuf.Parser<AnswerQueryRequest>	getParserForType()
Query	getQuery() Required.
QueryOrBuilder	getQueryOrBuilder() Required.
AnswerQueryRequest.QueryUnderstandingSpec	getQueryUnderstandingSpec() Query understanding specification.
AnswerQueryRequest.QueryUnderstandingSpecOrBuilder	getQueryUnderstandingSpecOrBuilder() Query understanding specification.
AnswerQueryRequest.RelatedQuestionsSpec	getRelatedQuestionsSpec() Related questions specification.
AnswerQueryRequest.RelatedQuestionsSpecOrBuilder	getRelatedQuestionsSpecOrBuilder() Related questions specification.
AnswerQueryRequest.SafetySpec	getSafetySpec() Model specification.
AnswerQueryRequest.SafetySpecOrBuilder	getSafetySpecOrBuilder() Model specification.
AnswerQueryRequest.SearchSpec	getSearchSpec() Search specification.
AnswerQueryRequest.SearchSpecOrBuilder	getSearchSpecOrBuilder() Search specification.
int	getSerializedSize()
String	getServingConfig() Required.
com.google.protobuf.ByteString	getServingConfigBytes() Required.
String	getSession() The session resource name.
com.google.protobuf.ByteString	getSessionBytes() The session resource name.
Map<String,String>	getUserLabels() Deprecated.
int	getUserLabelsCount() The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
Map<String,String>	getUserLabelsMap() The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
String	getUserLabelsOrDefault(String key, String defaultValue) The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
String	getUserLabelsOrThrow(String key) The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
String	getUserPseudoId() A unique identifier for tracking visitors.
com.google.protobuf.ByteString	getUserPseudoIdBytes() A unique identifier for tracking visitors.
boolean	hasAnswerGenerationSpec() Answer generation specification.
boolean	hasGroundingSpec() Optional.
int	hashCode()
boolean	hasQuery() Required.
boolean	hasQueryUnderstandingSpec() Query understanding specification.
boolean	hasRelatedQuestionsSpec() Related questions specification.
boolean	hasSafetySpec() Model specification.
boolean	hasSearchSpec() Search specification.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
boolean	isInitialized()
static AnswerQueryRequest.Builder	newBuilder()
static AnswerQueryRequest.Builder	newBuilder(AnswerQueryRequest prototype)
AnswerQueryRequest.Builder	newBuilderForType()
protected AnswerQueryRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static AnswerQueryRequest	parseDelimitedFrom(InputStream input)
static AnswerQueryRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnswerQueryRequest	parseFrom(byte[] data)
static AnswerQueryRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnswerQueryRequest	parseFrom(ByteBuffer data)
static AnswerQueryRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnswerQueryRequest	parseFrom(com.google.protobuf.ByteString data)
static AnswerQueryRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnswerQueryRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static AnswerQueryRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnswerQueryRequest	parseFrom(InputStream input)
static AnswerQueryRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<AnswerQueryRequest>	parser()
AnswerQueryRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

SERVING_CONFIG_FIELD_NUMBER

public static final int SERVING_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER

See Also:

Constant Field Values

SESSION_FIELD_NUMBER

public static final int SESSION_FIELD_NUMBER

See Also:

Constant Field Values

SAFETY_SPEC_FIELD_NUMBER

public static final int SAFETY_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

RELATED_QUESTIONS_SPEC_FIELD_NUMBER

public static final int RELATED_QUESTIONS_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

GROUNDING_SPEC_FIELD_NUMBER

public static final int GROUNDING_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

ANSWER_GENERATION_SPEC_FIELD_NUMBER

public static final int ANSWER_GENERATION_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

SEARCH_SPEC_FIELD_NUMBER

public static final int SEARCH_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

QUERY_UNDERSTANDING_SPEC_FIELD_NUMBER

public static final int QUERY_UNDERSTANDING_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

ASYNCHRONOUS_MODE_FIELD_NUMBER

public static final int ASYNCHRONOUS_MODE_FIELD_NUMBER

See Also:

Constant Field Values

USER_PSEUDO_ID_FIELD_NUMBER

public static final int USER_PSEUDO_ID_FIELD_NUMBER

See Also:

Constant Field Values

USER_LABELS_FIELD_NUMBER

public static final int USER_LABELS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getServingConfig

public String getServingConfig()

 Required. The resource name of the Search serving config, such as
 `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
 or
 `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`.
 This field is used to identify the serving configuration name, set
 of models used to make the search.
 

string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getServingConfig in interface AnswerQueryRequestOrBuilder

Returns:

The servingConfig.

getServingConfigBytes

public com.google.protobuf.ByteString getServingConfigBytes()

 Required. The resource name of the Search serving config, such as
 `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
 or
 `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`.
 This field is used to identify the serving configuration name, set
 of models used to make the search.
 

string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getServingConfigBytes in interface AnswerQueryRequestOrBuilder

Returns:

The bytes for servingConfig.

hasQuery

public boolean hasQuery()

 Required. Current user query.
 

.google.cloud.discoveryengine.v1beta.Query query = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

hasQuery in interface AnswerQueryRequestOrBuilder

Returns:

Whether the query field is set.

getQuery

public Query getQuery()

 Required. Current user query.
 

.google.cloud.discoveryengine.v1beta.Query query = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getQuery in interface AnswerQueryRequestOrBuilder

Returns:

The query.

getQueryOrBuilder

public QueryOrBuilder getQueryOrBuilder()

 Required. Current user query.
 

.google.cloud.discoveryengine.v1beta.Query query = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getQueryOrBuilder in interface AnswerQueryRequestOrBuilder

getSession

public String getSession()

 The session resource name. Not required.

 When session field is not set, the API is in sessionless mode.

 We support auto session mode: users can use the wildcard symbol `-` as
 session ID.  A new ID will be automatically generated and assigned.
 

string session = 3 [(.google.api.resource_reference) = { ... }

Specified by:

getSession in interface AnswerQueryRequestOrBuilder

Returns:

The session.

getSessionBytes

public com.google.protobuf.ByteString getSessionBytes()

 The session resource name. Not required.

 When session field is not set, the API is in sessionless mode.

 We support auto session mode: users can use the wildcard symbol `-` as
 session ID.  A new ID will be automatically generated and assigned.
 

string session = 3 [(.google.api.resource_reference) = { ... }

Specified by:

getSessionBytes in interface AnswerQueryRequestOrBuilder

Returns:

The bytes for session.

hasSafetySpec

public boolean hasSafetySpec()

 Model specification.
 

.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SafetySpec safety_spec = 4;

Specified by:

hasSafetySpec in interface AnswerQueryRequestOrBuilder

Returns:

Whether the safetySpec field is set.

getSafetySpec

public AnswerQueryRequest.SafetySpec getSafetySpec()

 Model specification.
 

.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SafetySpec safety_spec = 4;

Specified by:

getSafetySpec in interface AnswerQueryRequestOrBuilder

Returns:

The safetySpec.

getSafetySpecOrBuilder

public AnswerQueryRequest.SafetySpecOrBuilder getSafetySpecOrBuilder()

 Model specification.
 

.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SafetySpec safety_spec = 4;

Specified by:

getSafetySpecOrBuilder in interface AnswerQueryRequestOrBuilder

hasRelatedQuestionsSpec

public boolean hasRelatedQuestionsSpec()

 Related questions specification.
 

.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.RelatedQuestionsSpec related_questions_spec = 5;

Specified by:

hasRelatedQuestionsSpec in interface AnswerQueryRequestOrBuilder

Returns:

Whether the relatedQuestionsSpec field is set.

getRelatedQuestionsSpec

public AnswerQueryRequest.RelatedQuestionsSpec getRelatedQuestionsSpec()

 Related questions specification.
 

.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.RelatedQuestionsSpec related_questions_spec = 5;

Specified by:

getRelatedQuestionsSpec in interface AnswerQueryRequestOrBuilder

Returns:

The relatedQuestionsSpec.

getRelatedQuestionsSpecOrBuilder

public AnswerQueryRequest.RelatedQuestionsSpecOrBuilder getRelatedQuestionsSpecOrBuilder()

 Related questions specification.
 

.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.RelatedQuestionsSpec related_questions_spec = 5;

Specified by:

getRelatedQuestionsSpecOrBuilder in interface AnswerQueryRequestOrBuilder

hasGroundingSpec

public boolean hasGroundingSpec()

 Optional. Grounding specification.
 

.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.GroundingSpec grounding_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasGroundingSpec in interface AnswerQueryRequestOrBuilder

Returns:

Whether the groundingSpec field is set.

getGroundingSpec

public AnswerQueryRequest.GroundingSpec getGroundingSpec()

 Optional. Grounding specification.
 

.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.GroundingSpec grounding_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getGroundingSpec in interface AnswerQueryRequestOrBuilder

Returns:

The groundingSpec.

getGroundingSpecOrBuilder

public AnswerQueryRequest.GroundingSpecOrBuilder getGroundingSpecOrBuilder()

 Optional. Grounding specification.
 

.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.GroundingSpec grounding_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getGroundingSpecOrBuilder in interface AnswerQueryRequestOrBuilder

hasAnswerGenerationSpec

public boolean hasAnswerGenerationSpec()

 Answer generation specification.
 

.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec answer_generation_spec = 7;

Specified by:

hasAnswerGenerationSpec in interface AnswerQueryRequestOrBuilder

Returns:

Whether the answerGenerationSpec field is set.

getAnswerGenerationSpec

public AnswerQueryRequest.AnswerGenerationSpec getAnswerGenerationSpec()

 Answer generation specification.
 

.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec answer_generation_spec = 7;

Specified by:

getAnswerGenerationSpec in interface AnswerQueryRequestOrBuilder

Returns:

The answerGenerationSpec.

getAnswerGenerationSpecOrBuilder

public AnswerQueryRequest.AnswerGenerationSpecOrBuilder getAnswerGenerationSpecOrBuilder()

 Answer generation specification.
 

.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec answer_generation_spec = 7;

Specified by:

getAnswerGenerationSpecOrBuilder in interface AnswerQueryRequestOrBuilder

hasSearchSpec

public boolean hasSearchSpec()

 Search specification.
 

.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SearchSpec search_spec = 8;

Specified by:

hasSearchSpec in interface AnswerQueryRequestOrBuilder

Returns:

Whether the searchSpec field is set.

getSearchSpec

public AnswerQueryRequest.SearchSpec getSearchSpec()

 Search specification.
 

.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SearchSpec search_spec = 8;

Specified by:

getSearchSpec in interface AnswerQueryRequestOrBuilder

Returns:

The searchSpec.

getSearchSpecOrBuilder

public AnswerQueryRequest.SearchSpecOrBuilder getSearchSpecOrBuilder()

 Search specification.
 

.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SearchSpec search_spec = 8;

Specified by:

getSearchSpecOrBuilder in interface AnswerQueryRequestOrBuilder

hasQueryUnderstandingSpec

public boolean hasQueryUnderstandingSpec()

 Query understanding specification.
 

.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.QueryUnderstandingSpec query_understanding_spec = 9;

Specified by:

hasQueryUnderstandingSpec in interface AnswerQueryRequestOrBuilder

Returns:

Whether the queryUnderstandingSpec field is set.

getQueryUnderstandingSpec

public AnswerQueryRequest.QueryUnderstandingSpec getQueryUnderstandingSpec()

 Query understanding specification.
 

.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.QueryUnderstandingSpec query_understanding_spec = 9;

Specified by:

getQueryUnderstandingSpec in interface AnswerQueryRequestOrBuilder

Returns:

The queryUnderstandingSpec.

getQueryUnderstandingSpecOrBuilder

public AnswerQueryRequest.QueryUnderstandingSpecOrBuilder getQueryUnderstandingSpecOrBuilder()

 Query understanding specification.
 

.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.QueryUnderstandingSpec query_understanding_spec = 9;

Specified by:

getQueryUnderstandingSpecOrBuilder in interface AnswerQueryRequestOrBuilder

getAsynchronousMode

@Deprecated
public boolean getAsynchronousMode()

Deprecated. google.cloud.discoveryengine.v1beta.AnswerQueryRequest.asynchronous_mode is deprecated. See google/cloud/discoveryengine/v1beta/conversational_search_service.proto;l=861

 Deprecated: This field is deprecated. Streaming Answer API will be
 supported.

 Asynchronous mode control.

 If enabled, the response will be returned with answer/session resource
 name without final answer. The API users need to do the polling to get
 the latest status of answer/session by calling
 [ConversationalSearchService.GetAnswer][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetAnswer]
 or
 [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetSession]
 method.
 

bool asynchronous_mode = 10 [deprecated = true];

Specified by:

getAsynchronousMode in interface AnswerQueryRequestOrBuilder

Returns:

The asynchronousMode.

getUserPseudoId

public String getUserPseudoId()

 A unique identifier for tracking visitors. For example, this could be
 implemented with an HTTP cookie, which should be able to uniquely identify
 a visitor on a single device. This unique identifier should not change if
 the visitor logs in or out of the website.

 This field should NOT have a fixed value such as `unknown_visitor`.

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
 

string user_pseudo_id = 12;

Specified by:

getUserPseudoId in interface AnswerQueryRequestOrBuilder

Returns:

The userPseudoId.

getUserPseudoIdBytes

public com.google.protobuf.ByteString getUserPseudoIdBytes()

 A unique identifier for tracking visitors. For example, this could be
 implemented with an HTTP cookie, which should be able to uniquely identify
 a visitor on a single device. This unique identifier should not change if
 the visitor logs in or out of the website.

 This field should NOT have a fixed value such as `unknown_visitor`.

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
 

string user_pseudo_id = 12;

Specified by:

getUserPseudoIdBytes in interface AnswerQueryRequestOrBuilder

Returns:

The bytes for userPseudoId.

getUserLabelsCount

public int getUserLabelsCount()

Description copied from interface: AnswerQueryRequestOrBuilder

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> user_labels = 13;

Specified by:

getUserLabelsCount in interface AnswerQueryRequestOrBuilder

containsUserLabels

public boolean containsUserLabels(String key)

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> user_labels = 13;

Specified by:

containsUserLabels in interface AnswerQueryRequestOrBuilder

getUserLabels

@Deprecated
public Map<String,String> getUserLabels()

Deprecated.

Use getUserLabelsMap() instead.

Specified by:

getUserLabels in interface AnswerQueryRequestOrBuilder

getUserLabelsMap

public Map<String,String> getUserLabelsMap()

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> user_labels = 13;

Specified by:

getUserLabelsMap in interface AnswerQueryRequestOrBuilder

getUserLabelsOrDefault

public String getUserLabelsOrDefault(String key,
                                     String defaultValue)

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> user_labels = 13;

Specified by:

getUserLabelsOrDefault in interface AnswerQueryRequestOrBuilder

getUserLabelsOrThrow

public String getUserLabelsOrThrow(String key)

 The user labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> user_labels = 13;

Specified by:

getUserLabelsOrThrow in interface AnswerQueryRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static AnswerQueryRequest parseFrom(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnswerQueryRequest parseFrom(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnswerQueryRequest parseFrom(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnswerQueryRequest parseFrom(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnswerQueryRequest parseFrom(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnswerQueryRequest parseFrom(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnswerQueryRequest parseFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

public static AnswerQueryRequest parseFrom(InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static AnswerQueryRequest parseDelimitedFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static AnswerQueryRequest parseDelimitedFrom(InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

parseFrom

public static AnswerQueryRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

public static AnswerQueryRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

newBuilderForType

public AnswerQueryRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static AnswerQueryRequest.Builder newBuilder()

newBuilder

public static AnswerQueryRequest.Builder newBuilder(AnswerQueryRequest prototype)

toBuilder

public AnswerQueryRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected AnswerQueryRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static AnswerQueryRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<AnswerQueryRequest> parser()

getParserForType

public com.google.protobuf.Parser<AnswerQueryRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public AnswerQueryRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder