public final class CompletionConfig extends com.google.protobuf.GeneratedMessageV3 implements CompletionConfigOrBuilder
Catalog level autocomplete config for customers to customize autocomplete feature's settings.Protobuf type
google.cloud.retail.v2.CompletionConfig| Modifier and Type | Class and Description |
|---|---|
static class |
CompletionConfig.Builder
Catalog level autocomplete config for customers to customize autocomplete
feature's settings.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
ALLOWLIST_INPUT_CONFIG_FIELD_NUMBER |
static int |
AUTO_LEARNING_FIELD_NUMBER |
static int |
DENYLIST_INPUT_CONFIG_FIELD_NUMBER |
static int |
LAST_ALLOWLIST_IMPORT_OPERATION_FIELD_NUMBER |
static int |
LAST_DENYLIST_IMPORT_OPERATION_FIELD_NUMBER |
static int |
LAST_SUGGESTIONS_IMPORT_OPERATION_FIELD_NUMBER |
static int |
MATCHING_ORDER_FIELD_NUMBER |
static int |
MAX_SUGGESTIONS_FIELD_NUMBER |
static int |
MIN_PREFIX_LENGTH_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
SUGGESTIONS_INPUT_CONFIG_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
CompletionDataInputConfig |
getAllowlistInputConfig()
Output only.
|
CompletionDataInputConfigOrBuilder |
getAllowlistInputConfigOrBuilder()
Output only.
|
boolean |
getAutoLearning()
If set to true, the auto learning function is enabled.
|
static CompletionConfig |
getDefaultInstance() |
CompletionConfig |
getDefaultInstanceForType() |
CompletionDataInputConfig |
getDenylistInputConfig()
Output only.
|
CompletionDataInputConfigOrBuilder |
getDenylistInputConfigOrBuilder()
Output only.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getLastAllowlistImportOperation()
Output only.
|
com.google.protobuf.ByteString |
getLastAllowlistImportOperationBytes()
Output only.
|
String |
getLastDenylistImportOperation()
Output only.
|
com.google.protobuf.ByteString |
getLastDenylistImportOperationBytes()
Output only.
|
String |
getLastSuggestionsImportOperation()
Output only.
|
com.google.protobuf.ByteString |
getLastSuggestionsImportOperationBytes()
Output only.
|
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".
|
com.google.protobuf.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".
|
int |
getMaxSuggestions()
The maximum number of autocomplete suggestions returned per term.
|
int |
getMinPrefixLength()
The minimum number of characters needed to be typed in order to get
suggestions.
|
String |
getName()
Required.
|
com.google.protobuf.ByteString |
getNameBytes()
Required.
|
com.google.protobuf.Parser<CompletionConfig> |
getParserForType() |
int |
getSerializedSize() |
CompletionDataInputConfig |
getSuggestionsInputConfig()
Output only.
|
CompletionDataInputConfigOrBuilder |
getSuggestionsInputConfigOrBuilder()
Output only.
|
boolean |
hasAllowlistInputConfig()
Output only.
|
boolean |
hasDenylistInputConfig()
Output only.
|
int |
hashCode() |
boolean |
hasSuggestionsInputConfig()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static CompletionConfig.Builder |
newBuilder() |
static CompletionConfig.Builder |
newBuilder(CompletionConfig prototype) |
CompletionConfig.Builder |
newBuilderForType() |
protected CompletionConfig.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static CompletionConfig |
parseDelimitedFrom(InputStream input) |
static CompletionConfig |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CompletionConfig |
parseFrom(byte[] data) |
static CompletionConfig |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CompletionConfig |
parseFrom(ByteBuffer data) |
static CompletionConfig |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CompletionConfig |
parseFrom(com.google.protobuf.ByteString data) |
static CompletionConfig |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CompletionConfig |
parseFrom(com.google.protobuf.CodedInputStream input) |
static CompletionConfig |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CompletionConfig |
parseFrom(InputStream input) |
static CompletionConfig |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<CompletionConfig> |
parser() |
CompletionConfig.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int MATCHING_ORDER_FIELD_NUMBER
public static final int MAX_SUGGESTIONS_FIELD_NUMBER
public static final int MIN_PREFIX_LENGTH_FIELD_NUMBER
public static final int AUTO_LEARNING_FIELD_NUMBER
public static final int SUGGESTIONS_INPUT_CONFIG_FIELD_NUMBER
public static final int LAST_SUGGESTIONS_IMPORT_OPERATION_FIELD_NUMBER
public static final int DENYLIST_INPUT_CONFIG_FIELD_NUMBER
public static final int LAST_DENYLIST_IMPORT_OPERATION_FIELD_NUMBER
public static final int ALLOWLIST_INPUT_CONFIG_FIELD_NUMBER
public static final int LAST_ALLOWLIST_IMPORT_OPERATION_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getName()
Required. Immutable. Fully qualified name `projects/*/locations/*/catalogs/*/completionConfig`
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
getName in interface CompletionConfigOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Required. Immutable. Fully qualified name `projects/*/locations/*/catalogs/*/completionConfig`
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
getNameBytes in interface CompletionConfigOrBuilderpublic 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;getMatchingOrder in interface CompletionConfigOrBuilderpublic com.google.protobuf.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;getMatchingOrderBytes in interface CompletionConfigOrBuilderpublic 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;getMaxSuggestions in interface CompletionConfigOrBuilderpublic 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;getMinPrefixLength in interface CompletionConfigOrBuilderpublic 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][google.cloud.retail.v2.CompleteQueryRequest].
bool auto_learning = 11;getAutoLearning in interface CompletionConfigOrBuilderpublic boolean hasSuggestionsInputConfig()
Output only. The source data for the latest import of the autocomplete suggestion phrases.
.google.cloud.retail.v2.CompletionDataInputConfig suggestions_input_config = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasSuggestionsInputConfig in interface CompletionConfigOrBuilderpublic CompletionDataInputConfig getSuggestionsInputConfig()
Output only. The source data for the latest import of the autocomplete suggestion phrases.
.google.cloud.retail.v2.CompletionDataInputConfig suggestions_input_config = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSuggestionsInputConfig in interface CompletionConfigOrBuilderpublic CompletionDataInputConfigOrBuilder getSuggestionsInputConfigOrBuilder()
Output only. The source data for the latest import of the autocomplete suggestion phrases.
.google.cloud.retail.v2.CompletionDataInputConfig suggestions_input_config = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSuggestionsInputConfigOrBuilder in interface CompletionConfigOrBuilderpublic String getLastSuggestionsImportOperation()
Output only. Name of the LRO corresponding to the latest suggestion terms list import. Can use [GetOperation][google.longrunning.Operations.GetOperation] API to retrieve the latest state of the Long Running Operation.
string last_suggestions_import_operation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getLastSuggestionsImportOperation in interface CompletionConfigOrBuilderpublic com.google.protobuf.ByteString getLastSuggestionsImportOperationBytes()
Output only. Name of the LRO corresponding to the latest suggestion terms list import. Can use [GetOperation][google.longrunning.Operations.GetOperation] API to retrieve the latest state of the Long Running Operation.
string last_suggestions_import_operation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getLastSuggestionsImportOperationBytes in interface CompletionConfigOrBuilderpublic boolean hasDenylistInputConfig()
Output only. The source data for the latest import of the autocomplete denylist phrases.
.google.cloud.retail.v2.CompletionDataInputConfig denylist_input_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasDenylistInputConfig in interface CompletionConfigOrBuilderpublic CompletionDataInputConfig getDenylistInputConfig()
Output only. The source data for the latest import of the autocomplete denylist phrases.
.google.cloud.retail.v2.CompletionDataInputConfig denylist_input_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDenylistInputConfig in interface CompletionConfigOrBuilderpublic CompletionDataInputConfigOrBuilder getDenylistInputConfigOrBuilder()
Output only. The source data for the latest import of the autocomplete denylist phrases.
.google.cloud.retail.v2.CompletionDataInputConfig denylist_input_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDenylistInputConfigOrBuilder in interface CompletionConfigOrBuilderpublic String getLastDenylistImportOperation()
Output only. Name of the LRO corresponding to the latest denylist import. Can use [GetOperation][google.longrunning.Operations.GetOperation] API to retrieve the latest state of the Long Running Operation.
string last_denylist_import_operation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getLastDenylistImportOperation in interface CompletionConfigOrBuilderpublic com.google.protobuf.ByteString getLastDenylistImportOperationBytes()
Output only. Name of the LRO corresponding to the latest denylist import. Can use [GetOperation][google.longrunning.Operations.GetOperation] API to retrieve the latest state of the Long Running Operation.
string last_denylist_import_operation = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getLastDenylistImportOperationBytes in interface CompletionConfigOrBuilderpublic boolean hasAllowlistInputConfig()
Output only. The source data for the latest import of the autocomplete allowlist phrases.
.google.cloud.retail.v2.CompletionDataInputConfig allowlist_input_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasAllowlistInputConfig in interface CompletionConfigOrBuilderpublic CompletionDataInputConfig getAllowlistInputConfig()
Output only. The source data for the latest import of the autocomplete allowlist phrases.
.google.cloud.retail.v2.CompletionDataInputConfig allowlist_input_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getAllowlistInputConfig in interface CompletionConfigOrBuilderpublic CompletionDataInputConfigOrBuilder getAllowlistInputConfigOrBuilder()
Output only. The source data for the latest import of the autocomplete allowlist phrases.
.google.cloud.retail.v2.CompletionDataInputConfig allowlist_input_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getAllowlistInputConfigOrBuilder in interface CompletionConfigOrBuilderpublic String getLastAllowlistImportOperation()
Output only. Name of the LRO corresponding to the latest allowlist import. Can use [GetOperation][google.longrunning.Operations.GetOperation] API to retrieve the latest state of the Long Running Operation.
string last_allowlist_import_operation = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getLastAllowlistImportOperation in interface CompletionConfigOrBuilderpublic com.google.protobuf.ByteString getLastAllowlistImportOperationBytes()
Output only. Name of the LRO corresponding to the latest allowlist import. Can use [GetOperation][google.longrunning.Operations.GetOperation] API to retrieve the latest state of the Long Running Operation.
string last_allowlist_import_operation = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getLastAllowlistImportOperationBytes in interface CompletionConfigOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static CompletionConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CompletionConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CompletionConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CompletionConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CompletionConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CompletionConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CompletionConfig parseFrom(InputStream input) throws IOException
IOExceptionpublic static CompletionConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static CompletionConfig parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static CompletionConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static CompletionConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static CompletionConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic CompletionConfig.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static CompletionConfig.Builder newBuilder()
public static CompletionConfig.Builder newBuilder(CompletionConfig prototype)
public CompletionConfig.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected CompletionConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static CompletionConfig getDefaultInstance()
public static com.google.protobuf.Parser<CompletionConfig> parser()
public com.google.protobuf.Parser<CompletionConfig> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public CompletionConfig getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.