Class AdvancedCompleteQueryRequest.Builder (0.50.0)

Version 0.50.0

• 0.51.0 (latest)
• 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 static final class AdvancedCompleteQueryRequest.Builder extends GeneratedMessageV3.Builder<AdvancedCompleteQueryRequest.Builder> implements AdvancedCompleteQueryRequestOrBuilder

Request message for CompletionService.AdvancedCompleteQuery method. .

Protobuf type google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AdvancedCompleteQueryRequest.Builder

Implements

AdvancedCompleteQueryRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllSuggestionTypes(Iterable<? extends AdvancedCompleteQueryRequest.SuggestionType> values)

public AdvancedCompleteQueryRequest.Builder addAllSuggestionTypes(Iterable<? extends AdvancedCompleteQueryRequest.SuggestionType> values)

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
values	Iterable<? extends com.google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType> The suggestionTypes to add.

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder	This builder for chaining.

addAllSuggestionTypesValue(Iterable<Integer> values)

public AdvancedCompleteQueryRequest.Builder addAllSuggestionTypesValue(Iterable<Integer> values)

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
values	Iterable<Integer> The enum numeric values on the wire for suggestionTypes to add.

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AdvancedCompleteQueryRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addSuggestionTypes(AdvancedCompleteQueryRequest.SuggestionType value)

public AdvancedCompleteQueryRequest.Builder addSuggestionTypes(AdvancedCompleteQueryRequest.SuggestionType value)

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
value	AdvancedCompleteQueryRequest.SuggestionType The suggestionTypes to add.

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder	This builder for chaining.

addSuggestionTypesValue(int value)

public AdvancedCompleteQueryRequest.Builder addSuggestionTypesValue(int value)

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
value	int The enum numeric value on the wire for suggestionTypes to add.

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder	This builder for chaining.

build()

public AdvancedCompleteQueryRequest build()

Returns
Type	Description
AdvancedCompleteQueryRequest

buildPartial()

public AdvancedCompleteQueryRequest buildPartial()

Returns
Type	Description
AdvancedCompleteQueryRequest

clear()

public AdvancedCompleteQueryRequest.Builder clear()

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBoostSpec()

public AdvancedCompleteQueryRequest.Builder clearBoostSpec()

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

clearCompletionConfig()

public AdvancedCompleteQueryRequest.Builder clearCompletionConfig()

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
AdvancedCompleteQueryRequest.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AdvancedCompleteQueryRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearIncludeTailSuggestions()

public AdvancedCompleteQueryRequest.Builder clearIncludeTailSuggestions()

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
AdvancedCompleteQueryRequest.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AdvancedCompleteQueryRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearQuery()

public AdvancedCompleteQueryRequest.Builder clearQuery()

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
AdvancedCompleteQueryRequest.Builder	This builder for chaining.

clearQueryModel()

public AdvancedCompleteQueryRequest.Builder clearQueryModel()

Specifies the autocomplete data model. 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
AdvancedCompleteQueryRequest.Builder	This builder for chaining.

clearSuggestionTypes()

public AdvancedCompleteQueryRequest.Builder clearSuggestionTypes()

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
AdvancedCompleteQueryRequest.Builder	This builder for chaining.

clearUserInfo()

public AdvancedCompleteQueryRequest.Builder clearUserInfo()

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
AdvancedCompleteQueryRequest.Builder

clearUserPseudoId()

public AdvancedCompleteQueryRequest.Builder clearUserPseudoId()

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;

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder	This builder for chaining.

clone()

public AdvancedCompleteQueryRequest.Builder clone()

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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.

getBoostSpecBuilder()

public AdvancedCompleteQueryRequest.BoostSpec.Builder getBoostSpecBuilder()

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

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

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 data model. 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 data model. 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.

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.

getUserInfoBuilder()

public UserInfo.Builder getUserInfoBuilder()

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

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()

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;

Returns
Type	Description
String	The userPseudoId.

getUserPseudoIdBytes()

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

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;

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeBoostSpec(AdvancedCompleteQueryRequest.BoostSpec value)

public AdvancedCompleteQueryRequest.Builder mergeBoostSpec(AdvancedCompleteQueryRequest.BoostSpec value)

Optional. Specification to boost suggestions matching the condition.

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

Parameter
Name	Description
value	AdvancedCompleteQueryRequest.BoostSpec

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder

mergeFrom(AdvancedCompleteQueryRequest other)

public AdvancedCompleteQueryRequest.Builder mergeFrom(AdvancedCompleteQueryRequest other)

Parameter
Name	Description
other	AdvancedCompleteQueryRequest

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AdvancedCompleteQueryRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public AdvancedCompleteQueryRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AdvancedCompleteQueryRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUserInfo(UserInfo value)

public AdvancedCompleteQueryRequest.Builder mergeUserInfo(UserInfo value)

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];

Parameter
Name	Description
value	UserInfo

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder

setBoostSpec(AdvancedCompleteQueryRequest.BoostSpec value)

public AdvancedCompleteQueryRequest.Builder setBoostSpec(AdvancedCompleteQueryRequest.BoostSpec value)

Optional. Specification to boost suggestions matching the condition.

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

Parameter
Name	Description
value	AdvancedCompleteQueryRequest.BoostSpec

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder

setBoostSpec(AdvancedCompleteQueryRequest.BoostSpec.Builder builderForValue)

public AdvancedCompleteQueryRequest.Builder setBoostSpec(AdvancedCompleteQueryRequest.BoostSpec.Builder builderForValue)

Optional. Specification to boost suggestions matching the condition.

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

Parameter
Name	Description
builderForValue	AdvancedCompleteQueryRequest.BoostSpec.Builder

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder

setCompletionConfig(String value)

public AdvancedCompleteQueryRequest.Builder setCompletionConfig(String value)

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) = { ... }

Parameter
Name	Description
value	String The completionConfig to set.

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder	This builder for chaining.

setCompletionConfigBytes(ByteString value)

public AdvancedCompleteQueryRequest.Builder setCompletionConfigBytes(ByteString value)

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) = { ... }

Parameter
Name	Description
value	ByteString The bytes for completionConfig to set.

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AdvancedCompleteQueryRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setIncludeTailSuggestions(boolean value)

public AdvancedCompleteQueryRequest.Builder setIncludeTailSuggestions(boolean value)

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;

Parameter
Name	Description
value	boolean The includeTailSuggestions to set.

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder	This builder for chaining.

setQuery(String value)

public AdvancedCompleteQueryRequest.Builder setQuery(String value)

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];

Parameter
Name	Description
value	String The query to set.

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder	This builder for chaining.

setQueryBytes(ByteString value)

public AdvancedCompleteQueryRequest.Builder setQueryBytes(ByteString value)

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];

Parameter
Name	Description
value	ByteString The bytes for query to set.

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder	This builder for chaining.

setQueryModel(String value)

public AdvancedCompleteQueryRequest.Builder setQueryModel(String value)

Specifies the autocomplete data model. 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;

Parameter
Name	Description
value	String The queryModel to set.

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder	This builder for chaining.

setQueryModelBytes(ByteString value)

public AdvancedCompleteQueryRequest.Builder setQueryModelBytes(ByteString value)

Specifies the autocomplete data model. 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;

Parameter
Name	Description
value	ByteString The bytes for queryModel to set.

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AdvancedCompleteQueryRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSuggestionTypes(int index, AdvancedCompleteQueryRequest.SuggestionType value)

public AdvancedCompleteQueryRequest.Builder setSuggestionTypes(int index, AdvancedCompleteQueryRequest.SuggestionType value)

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];

Parameters
Name	Description
index	int The index to set the value at.
value	AdvancedCompleteQueryRequest.SuggestionType The suggestionTypes to set.

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder	This builder for chaining.

setSuggestionTypesValue(int index, int value)

public AdvancedCompleteQueryRequest.Builder setSuggestionTypesValue(int index, int value)

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];

Parameters
Name	Description
index	int The index to set the value at.
value	int The enum numeric value on the wire for suggestionTypes to set.

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AdvancedCompleteQueryRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUserInfo(UserInfo value)

public AdvancedCompleteQueryRequest.Builder setUserInfo(UserInfo value)

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];

Parameter
Name	Description
value	UserInfo

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder

setUserInfo(UserInfo.Builder builderForValue)

public AdvancedCompleteQueryRequest.Builder setUserInfo(UserInfo.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	UserInfo.Builder

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder

setUserPseudoId(String value)

public AdvancedCompleteQueryRequest.Builder setUserPseudoId(String value)

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;

Parameter
Name	Description
value	String The userPseudoId to set.

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder	This builder for chaining.

setUserPseudoIdBytes(ByteString value)

public AdvancedCompleteQueryRequest.Builder setUserPseudoIdBytes(ByteString value)

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;

Parameter
Name	Description
value	ByteString The bytes for userPseudoId to set.

Returns
Type	Description
AdvancedCompleteQueryRequest.Builder	This builder for chaining.