Class AdvancedCompleteQueryRequest (0.90.0)

0.90.0 (latest) 0.89.0 0.87.0 0.84.0 0.83.0 0.81.0 0.79.0 0.78.0 0.77.0 0.76.0 0.74.0 0.72.0 0.71.0 0.70.0 0.69.0 0.68.0 0.66.0 0.64.0 0.63.0 0.60.0 0.59.0 0.58.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public final class AdvancedCompleteQueryRequest extends GeneratedMessage implements AdvancedCompleteQueryRequestOrBuilder

Request message for CompletionService.AdvancedCompleteQuery method. .

Protobuf type google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > AdvancedCompleteQueryRequest

Implements

AdvancedCompleteQueryRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

BOOST_SPEC_FIELD_NUMBER

public static final int BOOST_SPEC_FIELD_NUMBER

Field Value
Type	Description
int

COMPLETION_CONFIG_FIELD_NUMBER

public static final int COMPLETION_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

EXPERIMENT_IDS_FIELD_NUMBER

public static final int EXPERIMENT_IDS_FIELD_NUMBER

Field Value
Type	Description
int

INCLUDE_TAIL_SUGGESTIONS_FIELD_NUMBER

public static final int INCLUDE_TAIL_SUGGESTIONS_FIELD_NUMBER

Field Value
Type	Description
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER

Field Value
Type	Description
int

QUERY_MODEL_FIELD_NUMBER

public static final int QUERY_MODEL_FIELD_NUMBER

Field Value
Type	Description
int

SUGGESTION_TYPES_FIELD_NUMBER

public static final int SUGGESTION_TYPES_FIELD_NUMBER

Field Value
Type	Description
int

SUGGESTION_TYPE_SPECS_FIELD_NUMBER

public static final int SUGGESTION_TYPE_SPECS_FIELD_NUMBER

Field Value
Type	Description
int

USER_INFO_FIELD_NUMBER

public static final int USER_INFO_FIELD_NUMBER

Field Value
Type	Description
int

USER_PSEUDO_ID_FIELD_NUMBER

public static final int USER_PSEUDO_ID_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static AdvancedCompleteQueryRequest getDefaultInstance()

Returns
Type	Description
AdvancedCompleteQueryRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static AdvancedCompleteQueryRequest.Builder newBuilder()

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder

newBuilder(AdvancedCompleteQueryRequest prototype)

public static AdvancedCompleteQueryRequest.Builder newBuilder(AdvancedCompleteQueryRequest prototype)

Parameter
Name	Description
prototype	AdvancedCompleteQueryRequest

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder

parseDelimitedFrom(InputStream input)

public static AdvancedCompleteQueryRequest parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
AdvancedCompleteQueryRequest

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AdvancedCompleteQueryRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AdvancedCompleteQueryRequest

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static AdvancedCompleteQueryRequest parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
AdvancedCompleteQueryRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AdvancedCompleteQueryRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AdvancedCompleteQueryRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AdvancedCompleteQueryRequest parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
AdvancedCompleteQueryRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AdvancedCompleteQueryRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AdvancedCompleteQueryRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AdvancedCompleteQueryRequest parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
AdvancedCompleteQueryRequest

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AdvancedCompleteQueryRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AdvancedCompleteQueryRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static AdvancedCompleteQueryRequest parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
AdvancedCompleteQueryRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AdvancedCompleteQueryRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AdvancedCompleteQueryRequest

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static AdvancedCompleteQueryRequest parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
AdvancedCompleteQueryRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AdvancedCompleteQueryRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AdvancedCompleteQueryRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<AdvancedCompleteQueryRequest> parser()

Returns
Type	Description
Parser<AdvancedCompleteQueryRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getBoostSpec()

public AdvancedCompleteQueryRequest.BoostSpec getBoostSpec()

Optional. Specification to boost suggestions matching the condition.

.google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AdvancedCompleteQueryRequest.BoostSpec	The boostSpec.

getBoostSpecOrBuilder()

public AdvancedCompleteQueryRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()

Optional. Specification to boost suggestions matching the condition.

.google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AdvancedCompleteQueryRequest.BoostSpecOrBuilder

getCompletionConfig()

public String getCompletionConfig()

Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig projects/*/locations/global/collections/default_collection/engines/*/completionConfig.

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

Returns
Type	Description
String	The completionConfig.

getCompletionConfigBytes()

public ByteString getCompletionConfigBytes()

Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig projects/*/locations/global/collections/default_collection/engines/*/completionConfig.

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

Returns
Type	Description
ByteString	The bytes for completionConfig.

getDefaultInstanceForType()

public AdvancedCompleteQueryRequest getDefaultInstanceForType()

Returns
Type	Description
AdvancedCompleteQueryRequest

getExperimentIds(int index)

public String getExperimentIds(int index)

Optional. Experiment ids for this request.

repeated string experiment_ids = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The experimentIds at the given index.

getExperimentIdsBytes(int index)

public ByteString getExperimentIdsBytes(int index)

Optional. Experiment ids for this request.

repeated string experiment_ids = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the experimentIds at the given index.

getExperimentIdsCount()

public int getExperimentIdsCount()

Optional. Experiment ids for this request.

repeated string experiment_ids = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of experimentIds.

getExperimentIdsList()

public ProtocolStringList getExperimentIdsList()

Optional. Experiment ids for this request.

repeated string experiment_ids = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ProtocolStringList	A list containing the experimentIds.

getIncludeTailSuggestions()

public boolean getIncludeTailSuggestions()

Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.

bool include_tail_suggestions = 5;

Returns
Type	Description
boolean	The includeTailSuggestions.

getParserForType()

public Parser<AdvancedCompleteQueryRequest> getParserForType()

Returns
Type	Description
Parser<AdvancedCompleteQueryRequest>

Overrides

GeneratedMessage.getParserForType()

getQuery()

public String getQuery()

Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.

The query can not be empty for most of the suggestion types. If it is empty, an INVALID_ARGUMENT error is returned. The exception is when the suggestion_types contains only the type RECENT_SEARCH, the query can be an empty string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty query.

string query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The query.

getQueryBytes()

public ByteString getQueryBytes()

Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.

The query can not be empty for most of the suggestion types. If it is empty, an INVALID_ARGUMENT error is returned. The exception is when the suggestion_types contains only the type RECENT_SEARCH, the query can be an empty string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty query.

string query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for query.

getQueryModel()

public String getQueryModel()

Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values:

• document - Using suggestions generated from user-imported documents.
• search-history - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API.
• user-event - Using suggestions generated from user-imported search events.

• document-completable - Using suggestions taken directly from user-imported document fields marked as completable.

  Default values:

• document is the default model for regular dataStores.

• search-history is the default model for site search dataStores.

string query_model = 3;

Returns
Type	Description
String	The queryModel.

getQueryModelBytes()

public ByteString getQueryModelBytes()

Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values:

• document - Using suggestions generated from user-imported documents.
• search-history - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API.
• user-event - Using suggestions generated from user-imported search events.

• document-completable - Using suggestions taken directly from user-imported document fields marked as completable.

  Default values:

• document is the default model for regular dataStores.

• search-history is the default model for site search dataStores.

string query_model = 3;

Returns
Type	Description
ByteString	The bytes for queryModel.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

getSuggestionTypeSpecs(int index)

public AdvancedCompleteQueryRequest.SuggestionTypeSpec getSuggestionTypeSpecs(int index)

Optional. Specification of each suggestion type.

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionTypeSpec suggestion_type_specs = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
AdvancedCompleteQueryRequest.SuggestionTypeSpec

getSuggestionTypeSpecsCount()

public int getSuggestionTypeSpecsCount()

Optional. Specification of each suggestion type.

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionTypeSpec suggestion_type_specs = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getSuggestionTypeSpecsList()

public List<AdvancedCompleteQueryRequest.SuggestionTypeSpec> getSuggestionTypeSpecsList()

Optional. Specification of each suggestion type.

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionTypeSpec suggestion_type_specs = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<SuggestionTypeSpec>

getSuggestionTypeSpecsOrBuilder(int index)

public AdvancedCompleteQueryRequest.SuggestionTypeSpecOrBuilder getSuggestionTypeSpecsOrBuilder(int index)

Optional. Specification of each suggestion type.

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionTypeSpec suggestion_type_specs = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
AdvancedCompleteQueryRequest.SuggestionTypeSpecOrBuilder

getSuggestionTypeSpecsOrBuilderList()

public List<? extends AdvancedCompleteQueryRequest.SuggestionTypeSpecOrBuilder> getSuggestionTypeSpecsOrBuilderList()

Optional. Specification of each suggestion type.

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionTypeSpec suggestion_type_specs = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionTypeSpecOrBuilder>

getSuggestionTypes(int index)

public AdvancedCompleteQueryRequest.SuggestionType getSuggestionTypes(int index)

Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
AdvancedCompleteQueryRequest.SuggestionType	The suggestionTypes at the given index.

getSuggestionTypesCount()

public int getSuggestionTypesCount()

Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of suggestionTypes.

getSuggestionTypesList()

public List<AdvancedCompleteQueryRequest.SuggestionType> getSuggestionTypesList()

Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<SuggestionType>	A list containing the suggestionTypes.

getSuggestionTypesValue(int index)

public int getSuggestionTypesValue(int index)

Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
int	The enum numeric value on the wire of suggestionTypes at the given index.

getSuggestionTypesValueList()

public List<Integer> getSuggestionTypesValueList()

Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Integer>	A list containing the enum numeric values on the wire for suggestionTypes.

getUserInfo()

public UserInfo getUserInfo()

Optional. Information about the end user.

This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info.

.google.cloud.discoveryengine.v1beta.UserInfo user_info = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
UserInfo	The userInfo.

getUserInfoOrBuilder()

public UserInfoOrBuilder getUserInfoOrBuilder()

Optional. Information about the end user.

This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info.

.google.cloud.discoveryengine.v1beta.UserInfo user_info = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
UserInfoOrBuilder

getUserPseudoId()

public String getUserPseudoId()

Optional. 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.

This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id.

The field must be a UTF-8 encoded string with a length limit of 128

string user_pseudo_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The userPseudoId.

getUserPseudoIdBytes()

public ByteString getUserPseudoIdBytes()

Optional. 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.

This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id.

The field must be a UTF-8 encoded string with a length limit of 128

string user_pseudo_id = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for userPseudoId.

hasBoostSpec()

public boolean hasBoostSpec()

Optional. Specification to boost suggestions matching the condition.

.google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the boostSpec field is set.

hasUserInfo()

public boolean hasUserInfo()

Optional. Information about the end user.

This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info.

.google.cloud.discoveryengine.v1beta.UserInfo user_info = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the userInfo field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public AdvancedCompleteQueryRequest.Builder newBuilderForType()

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected AdvancedCompleteQueryRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public AdvancedCompleteQueryRequest.Builder toBuilder()

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException