Class CompletionConfig.Builder (2.5.1)

Version 2.5.1

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.3
• 2.1.0
• 2.0.19

public static final class CompletionConfig.Builder extends GeneratedMessageV3.Builder<CompletionConfig.Builder> implements CompletionConfigOrBuilder

Catalog level autocomplete config for customers to customize autocomplete feature's settings.

Protobuf type google.cloud.retail.v2beta.CompletionConfig

Inheritance

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

Implements

CompletionConfigOrBuilder

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)

GeneratedMessageV3.Builder.internalGetMutableMapField(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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
CompletionConfig.Builder

Overrides

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

build()

public CompletionConfig build()

Returns

Type	Description
CompletionConfig

buildPartial()

public CompletionConfig buildPartial()

Returns

Type	Description
CompletionConfig

clear()

public CompletionConfig.Builder clear()

Returns

Type	Description
CompletionConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAllowlistInputConfig()

public CompletionConfig.Builder clearAllowlistInputConfig()

Output only. The source data for the latest import of the autocomplete allowlist phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig allowlist_input_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
CompletionConfig.Builder

clearAutoLearning()

public CompletionConfig.Builder clearAutoLearning()

If set to true, the auto learning function is enabled. Auto learning uses user data to generate suggestions using ML techniques. Default value is false. Only after enabling auto learning can users use cloud-retail data in CompleteQueryRequest.

bool auto_learning = 11;

Returns

Type	Description
CompletionConfig.Builder	This builder for chaining.

clearDenylistInputConfig()

public CompletionConfig.Builder clearDenylistInputConfig()

Output only. The source data for the latest import of the autocomplete denylist phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig denylist_input_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
CompletionConfig.Builder

clearField(Descriptors.FieldDescriptor field)

public CompletionConfig.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
CompletionConfig.Builder

Overrides

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

clearLastAllowlistImportOperation()

public CompletionConfig.Builder clearLastAllowlistImportOperation()

Output only. Name of the LRO corresponding to the latest allowlist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.

string last_allowlist_import_operation = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
CompletionConfig.Builder	This builder for chaining.

clearLastDenylistImportOperation()

public CompletionConfig.Builder clearLastDenylistImportOperation()

Output only. Name of the LRO corresponding to the latest denylist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.

string last_denylist_import_operation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
CompletionConfig.Builder	This builder for chaining.

clearLastSuggestionsImportOperation()

public CompletionConfig.Builder clearLastSuggestionsImportOperation()

Output only. Name of the LRO corresponding to the latest suggestion terms list import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.

string last_suggestions_import_operation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
CompletionConfig.Builder	This builder for chaining.

clearMatchingOrder()

public CompletionConfig.Builder clearMatchingOrder()

Specifies the matching order for autocomplete suggestions, e.g., a query consisting of 'sh' with 'out-of-order' specified would suggest "women's shoes", whereas a query of 'red s' with 'exact-prefix' specified would suggest "red shoes". Currently supported values:

• 'out-of-order'
• 'exact-prefix' Default value: 'exact-prefix'.

string matching_order = 2;

Returns

Type	Description
CompletionConfig.Builder	This builder for chaining.

clearMaxSuggestions()

public CompletionConfig.Builder clearMaxSuggestions()

The maximum number of autocomplete suggestions returned per term. Default value is 20. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20.

int32 max_suggestions = 3;

Returns

Type	Description
CompletionConfig.Builder	This builder for chaining.

clearMinPrefixLength()

public CompletionConfig.Builder clearMinPrefixLength()

The minimum number of characters needed to be typed in order to get suggestions. Default value is 2. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20.

int32 min_prefix_length = 4;

Returns

Type	Description
CompletionConfig.Builder	This builder for chaining.

clearName()

public CompletionConfig.Builder clearName()

Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/completionConfig

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
CompletionConfig.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CompletionConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
CompletionConfig.Builder

Overrides

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

clearSuggestionsInputConfig()

public CompletionConfig.Builder clearSuggestionsInputConfig()

Output only. The source data for the latest import of the autocomplete suggestion phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig suggestions_input_config = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
CompletionConfig.Builder

clone()

public CompletionConfig.Builder clone()

Returns

Type	Description
CompletionConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAllowlistInputConfig()

public CompletionDataInputConfig getAllowlistInputConfig()

Output only. The source data for the latest import of the autocomplete allowlist phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig allowlist_input_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
CompletionDataInputConfig	The allowlistInputConfig.

getAllowlistInputConfigBuilder()

public CompletionDataInputConfig.Builder getAllowlistInputConfigBuilder()

Output only. The source data for the latest import of the autocomplete allowlist phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig allowlist_input_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
CompletionDataInputConfig.Builder

getAllowlistInputConfigOrBuilder()

public CompletionDataInputConfigOrBuilder getAllowlistInputConfigOrBuilder()

Output only. The source data for the latest import of the autocomplete allowlist phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig allowlist_input_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
CompletionDataInputConfigOrBuilder

getAutoLearning()

public boolean getAutoLearning()

If set to true, the auto learning function is enabled. Auto learning uses user data to generate suggestions using ML techniques. Default value is false. Only after enabling auto learning can users use cloud-retail data in CompleteQueryRequest.

bool auto_learning = 11;

Returns

Type	Description
boolean	The autoLearning.

getDefaultInstanceForType()

public CompletionConfig getDefaultInstanceForType()

Returns

Type	Description
CompletionConfig

getDenylistInputConfig()

public CompletionDataInputConfig getDenylistInputConfig()

Output only. The source data for the latest import of the autocomplete denylist phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig denylist_input_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
CompletionDataInputConfig	The denylistInputConfig.

getDenylistInputConfigBuilder()

public CompletionDataInputConfig.Builder getDenylistInputConfigBuilder()

Output only. The source data for the latest import of the autocomplete denylist phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig denylist_input_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
CompletionDataInputConfig.Builder

getDenylistInputConfigOrBuilder()

public CompletionDataInputConfigOrBuilder getDenylistInputConfigOrBuilder()

Output only. The source data for the latest import of the autocomplete denylist phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig denylist_input_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
CompletionDataInputConfigOrBuilder

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getLastAllowlistImportOperation()

public String getLastAllowlistImportOperation()

Output only. Name of the LRO corresponding to the latest allowlist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.

string last_allowlist_import_operation = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
String	The lastAllowlistImportOperation.

getLastAllowlistImportOperationBytes()

public ByteString getLastAllowlistImportOperationBytes()

Output only. Name of the LRO corresponding to the latest allowlist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.

string last_allowlist_import_operation = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
ByteString	The bytes for lastAllowlistImportOperation.

getLastDenylistImportOperation()

public String getLastDenylistImportOperation()

Output only. Name of the LRO corresponding to the latest denylist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.

string last_denylist_import_operation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
String	The lastDenylistImportOperation.

getLastDenylistImportOperationBytes()

public ByteString getLastDenylistImportOperationBytes()

Output only. Name of the LRO corresponding to the latest denylist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.

string last_denylist_import_operation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
ByteString	The bytes for lastDenylistImportOperation.

getLastSuggestionsImportOperation()

public String getLastSuggestionsImportOperation()

Output only. Name of the LRO corresponding to the latest suggestion terms list import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.

string last_suggestions_import_operation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
String	The lastSuggestionsImportOperation.

getLastSuggestionsImportOperationBytes()

public ByteString getLastSuggestionsImportOperationBytes()

Output only. Name of the LRO corresponding to the latest suggestion terms list import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.

string last_suggestions_import_operation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
ByteString	The bytes for lastSuggestionsImportOperation.

getMatchingOrder()

public String getMatchingOrder()

Specifies the matching order for autocomplete suggestions, e.g., a query consisting of 'sh' with 'out-of-order' specified would suggest "women's shoes", whereas a query of 'red s' with 'exact-prefix' specified would suggest "red shoes". Currently supported values:

• 'out-of-order'
• 'exact-prefix' Default value: 'exact-prefix'.

string matching_order = 2;

Returns

Type	Description
String	The matchingOrder.

getMatchingOrderBytes()

public ByteString getMatchingOrderBytes()

Specifies the matching order for autocomplete suggestions, e.g., a query consisting of 'sh' with 'out-of-order' specified would suggest "women's shoes", whereas a query of 'red s' with 'exact-prefix' specified would suggest "red shoes". Currently supported values:

• 'out-of-order'
• 'exact-prefix' Default value: 'exact-prefix'.

string matching_order = 2;

Returns

Type	Description
ByteString	The bytes for matchingOrder.

getMaxSuggestions()

public int getMaxSuggestions()

The maximum number of autocomplete suggestions returned per term. Default value is 20. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20.

int32 max_suggestions = 3;

Returns

Type	Description
int	The maxSuggestions.

getMinPrefixLength()

public int getMinPrefixLength()

The minimum number of characters needed to be typed in order to get suggestions. Default value is 2. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20.

int32 min_prefix_length = 4;

Returns

Type	Description
int	The minPrefixLength.

getName()

public String getName()

Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/completionConfig

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/completionConfig

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns

Type	Description
ByteString	The bytes for name.

getSuggestionsInputConfig()

public CompletionDataInputConfig getSuggestionsInputConfig()

Output only. The source data for the latest import of the autocomplete suggestion phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig suggestions_input_config = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
CompletionDataInputConfig	The suggestionsInputConfig.

getSuggestionsInputConfigBuilder()

public CompletionDataInputConfig.Builder getSuggestionsInputConfigBuilder()

Output only. The source data for the latest import of the autocomplete suggestion phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig suggestions_input_config = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
CompletionDataInputConfig.Builder

getSuggestionsInputConfigOrBuilder()

public CompletionDataInputConfigOrBuilder getSuggestionsInputConfigOrBuilder()

Output only. The source data for the latest import of the autocomplete suggestion phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig suggestions_input_config = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
CompletionDataInputConfigOrBuilder

hasAllowlistInputConfig()

public boolean hasAllowlistInputConfig()

Output only. The source data for the latest import of the autocomplete allowlist phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig allowlist_input_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the allowlistInputConfig field is set.

hasDenylistInputConfig()

public boolean hasDenylistInputConfig()

Output only. The source data for the latest import of the autocomplete denylist phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig denylist_input_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the denylistInputConfig field is set.

hasSuggestionsInputConfig()

public boolean hasSuggestionsInputConfig()

Output only. The source data for the latest import of the autocomplete suggestion phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig suggestions_input_config = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the suggestionsInputConfig 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()

mergeAllowlistInputConfig(CompletionDataInputConfig value)

public CompletionConfig.Builder mergeAllowlistInputConfig(CompletionDataInputConfig value)

Output only. The source data for the latest import of the autocomplete allowlist phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig allowlist_input_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	CompletionDataInputConfig

Returns

Type	Description
CompletionConfig.Builder

mergeDenylistInputConfig(CompletionDataInputConfig value)

public CompletionConfig.Builder mergeDenylistInputConfig(CompletionDataInputConfig value)

Output only. The source data for the latest import of the autocomplete denylist phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig denylist_input_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	CompletionDataInputConfig

Returns

Type	Description
CompletionConfig.Builder

mergeFrom(CompletionConfig other)

public CompletionConfig.Builder mergeFrom(CompletionConfig other)

Parameter

Name	Description
other	CompletionConfig

Returns

Type	Description
CompletionConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
CompletionConfig.Builder

Overrides

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

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public CompletionConfig.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
CompletionConfig.Builder

Overrides

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

mergeSuggestionsInputConfig(CompletionDataInputConfig value)

public CompletionConfig.Builder mergeSuggestionsInputConfig(CompletionDataInputConfig value)

Output only. The source data for the latest import of the autocomplete suggestion phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig suggestions_input_config = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	CompletionDataInputConfig

Returns

Type	Description
CompletionConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CompletionConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
CompletionConfig.Builder

Overrides

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

setAllowlistInputConfig(CompletionDataInputConfig value)

public CompletionConfig.Builder setAllowlistInputConfig(CompletionDataInputConfig value)

Output only. The source data for the latest import of the autocomplete allowlist phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig allowlist_input_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	CompletionDataInputConfig

Returns

Type	Description
CompletionConfig.Builder

setAllowlistInputConfig(CompletionDataInputConfig.Builder builderForValue)

public CompletionConfig.Builder setAllowlistInputConfig(CompletionDataInputConfig.Builder builderForValue)

Output only. The source data for the latest import of the autocomplete allowlist phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig allowlist_input_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
builderForValue	CompletionDataInputConfig.Builder

Returns

Type	Description
CompletionConfig.Builder

setAutoLearning(boolean value)

public CompletionConfig.Builder setAutoLearning(boolean value)

If set to true, the auto learning function is enabled. Auto learning uses user data to generate suggestions using ML techniques. Default value is false. Only after enabling auto learning can users use cloud-retail data in CompleteQueryRequest.

bool auto_learning = 11;

Parameter

Name	Description
value	boolean The autoLearning to set.

Returns

Type	Description
CompletionConfig.Builder	This builder for chaining.

setDenylistInputConfig(CompletionDataInputConfig value)

public CompletionConfig.Builder setDenylistInputConfig(CompletionDataInputConfig value)

Output only. The source data for the latest import of the autocomplete denylist phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig denylist_input_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	CompletionDataInputConfig

Returns

Type	Description
CompletionConfig.Builder

setDenylistInputConfig(CompletionDataInputConfig.Builder builderForValue)

public CompletionConfig.Builder setDenylistInputConfig(CompletionDataInputConfig.Builder builderForValue)

Output only. The source data for the latest import of the autocomplete denylist phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig denylist_input_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
builderForValue	CompletionDataInputConfig.Builder

Returns

Type	Description
CompletionConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
CompletionConfig.Builder

Overrides

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

setLastAllowlistImportOperation(String value)

public CompletionConfig.Builder setLastAllowlistImportOperation(String value)

Output only. Name of the LRO corresponding to the latest allowlist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.

string last_allowlist_import_operation = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	String The lastAllowlistImportOperation to set.

Returns

Type	Description
CompletionConfig.Builder	This builder for chaining.

setLastAllowlistImportOperationBytes(ByteString value)

public CompletionConfig.Builder setLastAllowlistImportOperationBytes(ByteString value)

Output only. Name of the LRO corresponding to the latest allowlist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.

string last_allowlist_import_operation = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	ByteString The bytes for lastAllowlistImportOperation to set.

Returns

Type	Description
CompletionConfig.Builder	This builder for chaining.

setLastDenylistImportOperation(String value)

public CompletionConfig.Builder setLastDenylistImportOperation(String value)

Output only. Name of the LRO corresponding to the latest denylist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.

string last_denylist_import_operation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	String The lastDenylistImportOperation to set.

Returns

Type	Description
CompletionConfig.Builder	This builder for chaining.

setLastDenylistImportOperationBytes(ByteString value)

public CompletionConfig.Builder setLastDenylistImportOperationBytes(ByteString value)

Output only. Name of the LRO corresponding to the latest denylist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.

string last_denylist_import_operation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	ByteString The bytes for lastDenylistImportOperation to set.

Returns

Type	Description
CompletionConfig.Builder	This builder for chaining.

setLastSuggestionsImportOperation(String value)

public CompletionConfig.Builder setLastSuggestionsImportOperation(String value)

Output only. Name of the LRO corresponding to the latest suggestion terms list import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.

string last_suggestions_import_operation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	String The lastSuggestionsImportOperation to set.

Returns

Type	Description
CompletionConfig.Builder	This builder for chaining.

setLastSuggestionsImportOperationBytes(ByteString value)

public CompletionConfig.Builder setLastSuggestionsImportOperationBytes(ByteString value)

Output only. Name of the LRO corresponding to the latest suggestion terms list import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.

string last_suggestions_import_operation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	ByteString The bytes for lastSuggestionsImportOperation to set.

Returns

Type	Description
CompletionConfig.Builder	This builder for chaining.

setMatchingOrder(String value)

public CompletionConfig.Builder setMatchingOrder(String value)

Specifies the matching order for autocomplete suggestions, e.g., a query consisting of 'sh' with 'out-of-order' specified would suggest "women's shoes", whereas a query of 'red s' with 'exact-prefix' specified would suggest "red shoes". Currently supported values:

• 'out-of-order'
• 'exact-prefix' Default value: 'exact-prefix'.

string matching_order = 2;

Parameter

Name	Description
value	String The matchingOrder to set.

Returns

Type	Description
CompletionConfig.Builder	This builder for chaining.

setMatchingOrderBytes(ByteString value)

public CompletionConfig.Builder setMatchingOrderBytes(ByteString value)

Specifies the matching order for autocomplete suggestions, e.g., a query consisting of 'sh' with 'out-of-order' specified would suggest "women's shoes", whereas a query of 'red s' with 'exact-prefix' specified would suggest "red shoes". Currently supported values:

• 'out-of-order'
• 'exact-prefix' Default value: 'exact-prefix'.

string matching_order = 2;

Parameter

Name	Description
value	ByteString The bytes for matchingOrder to set.

Returns

Type	Description
CompletionConfig.Builder	This builder for chaining.

setMaxSuggestions(int value)

public CompletionConfig.Builder setMaxSuggestions(int value)

The maximum number of autocomplete suggestions returned per term. Default value is 20. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20.

int32 max_suggestions = 3;

Parameter

Name	Description
value	int The maxSuggestions to set.

Returns

Type	Description
CompletionConfig.Builder	This builder for chaining.

setMinPrefixLength(int value)

public CompletionConfig.Builder setMinPrefixLength(int value)

The minimum number of characters needed to be typed in order to get suggestions. Default value is 2. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20.

int32 min_prefix_length = 4;

Parameter

Name	Description
value	int The minPrefixLength to set.

Returns

Type	Description
CompletionConfig.Builder	This builder for chaining.

setName(String value)

public CompletionConfig.Builder setName(String value)

Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/completionConfig

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter

Name	Description
value	String The name to set.

Returns

Type	Description
CompletionConfig.Builder	This builder for chaining.

setNameBytes(ByteString value)

public CompletionConfig.Builder setNameBytes(ByteString value)

Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/completionConfig

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter

Name	Description
value	ByteString The bytes for name to set.

Returns

Type	Description
CompletionConfig.Builder	This builder for chaining.

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

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

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
CompletionConfig.Builder

Overrides

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

setSuggestionsInputConfig(CompletionDataInputConfig value)

public CompletionConfig.Builder setSuggestionsInputConfig(CompletionDataInputConfig value)

Output only. The source data for the latest import of the autocomplete suggestion phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig suggestions_input_config = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	CompletionDataInputConfig

Returns

Type	Description
CompletionConfig.Builder

setSuggestionsInputConfig(CompletionDataInputConfig.Builder builderForValue)

public CompletionConfig.Builder setSuggestionsInputConfig(CompletionDataInputConfig.Builder builderForValue)

Output only. The source data for the latest import of the autocomplete suggestion phrases.

.google.cloud.retail.v2beta.CompletionDataInputConfig suggestions_input_config = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
builderForValue	CompletionDataInputConfig.Builder

Returns

Type	Description
CompletionConfig.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final CompletionConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
CompletionConfig.Builder

Overrides

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