- 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 interface CompletionConfigOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAllowlistInputConfig()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
CompletionDataInputConfig | The allowlistInputConfig. |
getAllowlistInputConfigOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
CompletionDataInputConfigOrBuilder | |
getAutoLearning()
public abstract 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. |
getDenylistInputConfig()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
CompletionDataInputConfig | The denylistInputConfig. |
getDenylistInputConfigOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
CompletionDataInputConfigOrBuilder | |
getLastAllowlistImportOperation()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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];
| Returns | |
|---|---|
| Type | Description |
CompletionDataInputConfig | The suggestionsInputConfig. |
getSuggestionsInputConfigOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
CompletionDataInputConfigOrBuilder | |
hasAllowlistInputConfig()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the allowlistInputConfig field is set. |
hasDenylistInputConfig()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the denylistInputConfig field is set. |
hasSuggestionsInputConfig()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the suggestionsInputConfig field is set. |