Package com.google.cloud.retail.v2alpha

Interface CompletionConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    CompletionConfig, CompletionConfig.Builder
    public interface CompletionConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        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:
        The name.

      • getNameBytes

        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];
        Returns:
        The bytes for name.

      • getMatchingOrder

        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:
        The matchingOrder.

      • getMatchingOrderBytes

        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;
        Returns:
        The bytes for matchingOrder.

      • getMaxSuggestions

        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:
        The maxSuggestions.

      • getMinPrefixLength

        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:
        The minPrefixLength.

      • getAutoLearning

        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.v2alpha.CompleteQueryRequest].
        bool auto_learning = 11;
        Returns:
        The autoLearning.

      • hasSuggestionsInputConfig

        boolean hasSuggestionsInputConfig()
         Output only. The source data for the latest import of the autocomplete
 suggestion phrases.
        .google.cloud.retail.v2alpha.CompletionDataInputConfig suggestions_input_config = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the suggestionsInputConfig field is set.

      • getSuggestionsInputConfig

        CompletionDataInputConfig getSuggestionsInputConfig()
         Output only. The source data for the latest import of the autocomplete
 suggestion phrases.
        .google.cloud.retail.v2alpha.CompletionDataInputConfig suggestions_input_config = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The suggestionsInputConfig.

      • getSuggestionsInputConfigOrBuilder

        CompletionDataInputConfigOrBuilder getSuggestionsInputConfigOrBuilder()
         Output only. The source data for the latest import of the autocomplete
 suggestion phrases.
        .google.cloud.retail.v2alpha.CompletionDataInputConfig suggestions_input_config = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getLastSuggestionsImportOperation

        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];
        Returns:
        The lastSuggestionsImportOperation.

      • getLastSuggestionsImportOperationBytes

        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];
        Returns:
        The bytes for lastSuggestionsImportOperation.

      • hasDenylistInputConfig

        boolean hasDenylistInputConfig()
         Output only. The source data for the latest import of the autocomplete
 denylist phrases.
        .google.cloud.retail.v2alpha.CompletionDataInputConfig denylist_input_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the denylistInputConfig field is set.

      • getDenylistInputConfig

        CompletionDataInputConfig getDenylistInputConfig()
         Output only. The source data for the latest import of the autocomplete
 denylist phrases.
        .google.cloud.retail.v2alpha.CompletionDataInputConfig denylist_input_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The denylistInputConfig.

      • getDenylistInputConfigOrBuilder

        CompletionDataInputConfigOrBuilder getDenylistInputConfigOrBuilder()
         Output only. The source data for the latest import of the autocomplete
 denylist phrases.
        .google.cloud.retail.v2alpha.CompletionDataInputConfig denylist_input_config = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getLastDenylistImportOperation

        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];
        Returns:
        The lastDenylistImportOperation.

      • getLastDenylistImportOperationBytes

        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];
        Returns:
        The bytes for lastDenylistImportOperation.

      • hasAllowlistInputConfig

        boolean hasAllowlistInputConfig()
         Output only. The source data for the latest import of the autocomplete
 allowlist phrases.
        .google.cloud.retail.v2alpha.CompletionDataInputConfig allowlist_input_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the allowlistInputConfig field is set.

      • getAllowlistInputConfig

        CompletionDataInputConfig getAllowlistInputConfig()
         Output only. The source data for the latest import of the autocomplete
 allowlist phrases.
        .google.cloud.retail.v2alpha.CompletionDataInputConfig allowlist_input_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The allowlistInputConfig.

      • getAllowlistInputConfigOrBuilder

        CompletionDataInputConfigOrBuilder getAllowlistInputConfigOrBuilder()
         Output only. The source data for the latest import of the autocomplete
 allowlist phrases.
        .google.cloud.retail.v2alpha.CompletionDataInputConfig allowlist_input_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getLastAllowlistImportOperation

        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];
        Returns:
        The lastAllowlistImportOperation.

      • getLastAllowlistImportOperationBytes

        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];
        Returns:
        The bytes for lastAllowlistImportOperation.