Package com.google.cloud.retail.v2alpha

Class Control.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Control.Builder>
com.google.cloud.retail.v2alpha.Control.Builder
All Implemented Interfaces:
ControlOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Control
public static final class Control.Builder extends com.google.protobuf.GeneratedMessage.Builder<Control.Builder> implements ControlOrBuilder
 Configures dynamic metadata that can be linked to a
 [ServingConfig][google.cloud.retail.v2alpha.ServingConfig] and affect search
 or recommendation results at serving time.
Protobuf type google.cloud.retail.v2alpha.Control

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Control.Builder>

    • clear

      public Control.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Control.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Control.Builder>

    • getDefaultInstanceForType

      public Control getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public Control build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public Control buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public Control.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Control.Builder>

    • mergeFrom

      public Control.Builder mergeFrom(Control other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Control.Builder>

    • mergeFrom

      public Control.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Control.Builder>
      Throws:
      IOException

    • getControlCase

      public Control.ControlCase getControlCase()
      Specified by:
      getControlCase in interface ControlOrBuilder

    • clearControl

      public Control.Builder clearControl()

    • hasFacetSpec

      @Deprecated public boolean hasFacetSpec()
      Deprecated.
      google.cloud.retail.v2alpha.Control.facet_spec is deprecated. See google/cloud/retail/v2alpha/control.proto;l=51
       A facet specification to perform faceted search.

 Note that this field is deprecated and will throw NOT_IMPLEMENTED if
 used for creating a control.
      .google.cloud.retail.v2alpha.SearchRequest.FacetSpec facet_spec = 3 [deprecated = true];
      Specified by:
      hasFacetSpec in interface ControlOrBuilder
      Returns:
      Whether the facetSpec field is set.

    • getFacetSpec

      @Deprecated public SearchRequest.FacetSpec getFacetSpec()
      Deprecated.
      google.cloud.retail.v2alpha.Control.facet_spec is deprecated. See google/cloud/retail/v2alpha/control.proto;l=51
       A facet specification to perform faceted search.

 Note that this field is deprecated and will throw NOT_IMPLEMENTED if
 used for creating a control.
      .google.cloud.retail.v2alpha.SearchRequest.FacetSpec facet_spec = 3 [deprecated = true];
      Specified by:
      getFacetSpec in interface ControlOrBuilder
      Returns:
      The facetSpec.

    • setFacetSpec

      @Deprecated public Control.Builder setFacetSpec(SearchRequest.FacetSpec value)
      Deprecated.
       A facet specification to perform faceted search.

 Note that this field is deprecated and will throw NOT_IMPLEMENTED if
 used for creating a control.
      .google.cloud.retail.v2alpha.SearchRequest.FacetSpec facet_spec = 3 [deprecated = true];

    • setFacetSpec

      @Deprecated public Control.Builder setFacetSpec(SearchRequest.FacetSpec.Builder builderForValue)
      Deprecated.
       A facet specification to perform faceted search.

 Note that this field is deprecated and will throw NOT_IMPLEMENTED if
 used for creating a control.
      .google.cloud.retail.v2alpha.SearchRequest.FacetSpec facet_spec = 3 [deprecated = true];

    • mergeFacetSpec

      @Deprecated public Control.Builder mergeFacetSpec(SearchRequest.FacetSpec value)
      Deprecated.
       A facet specification to perform faceted search.

 Note that this field is deprecated and will throw NOT_IMPLEMENTED if
 used for creating a control.
      .google.cloud.retail.v2alpha.SearchRequest.FacetSpec facet_spec = 3 [deprecated = true];

    • clearFacetSpec

      @Deprecated public Control.Builder clearFacetSpec()
      Deprecated.
       A facet specification to perform faceted search.

 Note that this field is deprecated and will throw NOT_IMPLEMENTED if
 used for creating a control.
      .google.cloud.retail.v2alpha.SearchRequest.FacetSpec facet_spec = 3 [deprecated = true];

    • getFacetSpecBuilder

      @Deprecated public SearchRequest.FacetSpec.Builder getFacetSpecBuilder()
      Deprecated.
       A facet specification to perform faceted search.

 Note that this field is deprecated and will throw NOT_IMPLEMENTED if
 used for creating a control.
      .google.cloud.retail.v2alpha.SearchRequest.FacetSpec facet_spec = 3 [deprecated = true];

    • getFacetSpecOrBuilder

      @Deprecated public SearchRequest.FacetSpecOrBuilder getFacetSpecOrBuilder()
      Deprecated.
       A facet specification to perform faceted search.

 Note that this field is deprecated and will throw NOT_IMPLEMENTED if
 used for creating a control.
      .google.cloud.retail.v2alpha.SearchRequest.FacetSpec facet_spec = 3 [deprecated = true];
      Specified by:
      getFacetSpecOrBuilder in interface ControlOrBuilder

    • hasRule

      public boolean hasRule()
       A rule control - a condition-action pair.
 Enacts a set action when the condition is triggered.
 For example: Boost "gShoe" when query full matches "Running Shoes".
      .google.cloud.retail.v2alpha.Rule rule = 4;
      Specified by:
      hasRule in interface ControlOrBuilder
      Returns:
      Whether the rule field is set.

    • getRule

      public Rule getRule()
       A rule control - a condition-action pair.
 Enacts a set action when the condition is triggered.
 For example: Boost "gShoe" when query full matches "Running Shoes".
      .google.cloud.retail.v2alpha.Rule rule = 4;
      Specified by:
      getRule in interface ControlOrBuilder
      Returns:
      The rule.

    • setRule

      public Control.Builder setRule(Rule value)
       A rule control - a condition-action pair.
 Enacts a set action when the condition is triggered.
 For example: Boost "gShoe" when query full matches "Running Shoes".
      .google.cloud.retail.v2alpha.Rule rule = 4;

    • setRule

      public Control.Builder setRule(Rule.Builder builderForValue)
       A rule control - a condition-action pair.
 Enacts a set action when the condition is triggered.
 For example: Boost "gShoe" when query full matches "Running Shoes".
      .google.cloud.retail.v2alpha.Rule rule = 4;

    • mergeRule

      public Control.Builder mergeRule(Rule value)
       A rule control - a condition-action pair.
 Enacts a set action when the condition is triggered.
 For example: Boost "gShoe" when query full matches "Running Shoes".
      .google.cloud.retail.v2alpha.Rule rule = 4;

    • clearRule

      public Control.Builder clearRule()
       A rule control - a condition-action pair.
 Enacts a set action when the condition is triggered.
 For example: Boost "gShoe" when query full matches "Running Shoes".
      .google.cloud.retail.v2alpha.Rule rule = 4;

    • getRuleBuilder

      public Rule.Builder getRuleBuilder()
       A rule control - a condition-action pair.
 Enacts a set action when the condition is triggered.
 For example: Boost "gShoe" when query full matches "Running Shoes".
      .google.cloud.retail.v2alpha.Rule rule = 4;

    • getRuleOrBuilder

      public RuleOrBuilder getRuleOrBuilder()
       A rule control - a condition-action pair.
 Enacts a set action when the condition is triggered.
 For example: Boost "gShoe" when query full matches "Running Shoes".
      .google.cloud.retail.v2alpha.Rule rule = 4;
      Specified by:
      getRuleOrBuilder in interface ControlOrBuilder

    • getName

      public String getName()
       Immutable. Fully qualified name
 `projects/*/locations/global/catalogs/*/controls/*`
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getName in interface ControlOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Immutable. Fully qualified name
 `projects/*/locations/global/catalogs/*/controls/*`
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getNameBytes in interface ControlOrBuilder
      Returns:
      The bytes for name.

    • setName

      public Control.Builder setName(String value)
       Immutable. Fully qualified name
 `projects/*/locations/global/catalogs/*/controls/*`
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public Control.Builder clearName()
       Immutable. Fully qualified name
 `projects/*/locations/global/catalogs/*/controls/*`
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      This builder for chaining.

    • setNameBytes

      public Control.Builder setNameBytes(com.google.protobuf.ByteString value)
       Immutable. Fully qualified name
 `projects/*/locations/global/catalogs/*/controls/*`
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getDisplayName

      public String getDisplayName()
       Required. The human readable control display name. Used in Retail UI.

 This field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayName in interface ControlOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The human readable control display name. Used in Retail UI.

 This field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayNameBytes in interface ControlOrBuilder
      Returns:
      The bytes for displayName.

    • setDisplayName

      public Control.Builder setDisplayName(String value)
       Required. The human readable control display name. Used in Retail UI.

 This field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The displayName to set.
      Returns:
      This builder for chaining.

    • clearDisplayName

      public Control.Builder clearDisplayName()
       Required. The human readable control display name. Used in Retail UI.

 This field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setDisplayNameBytes

      public Control.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
       Required. The human readable control display name. Used in Retail UI.

 This field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.

    • getAssociatedServingConfigIdsList

      public com.google.protobuf.ProtocolStringList getAssociatedServingConfigIdsList()
       Output only. List of [serving
 config][google.cloud.retail.v2alpha.ServingConfig] ids that are associated
 with this control in the same
 [Catalog][google.cloud.retail.v2alpha.Catalog].

 Note the association is managed via the
 [ServingConfig][google.cloud.retail.v2alpha.ServingConfig], this is an
 output only denormalized view.
      repeated string associated_serving_config_ids = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAssociatedServingConfigIdsList in interface ControlOrBuilder
      Returns:
      A list containing the associatedServingConfigIds.

    • getAssociatedServingConfigIdsCount

      public int getAssociatedServingConfigIdsCount()
       Output only. List of [serving
 config][google.cloud.retail.v2alpha.ServingConfig] ids that are associated
 with this control in the same
 [Catalog][google.cloud.retail.v2alpha.Catalog].

 Note the association is managed via the
 [ServingConfig][google.cloud.retail.v2alpha.ServingConfig], this is an
 output only denormalized view.
      repeated string associated_serving_config_ids = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAssociatedServingConfigIdsCount in interface ControlOrBuilder
      Returns:
      The count of associatedServingConfigIds.

    • getAssociatedServingConfigIds

      public String getAssociatedServingConfigIds(int index)
       Output only. List of [serving
 config][google.cloud.retail.v2alpha.ServingConfig] ids that are associated
 with this control in the same
 [Catalog][google.cloud.retail.v2alpha.Catalog].

 Note the association is managed via the
 [ServingConfig][google.cloud.retail.v2alpha.ServingConfig], this is an
 output only denormalized view.
      repeated string associated_serving_config_ids = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAssociatedServingConfigIds in interface ControlOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The associatedServingConfigIds at the given index.

    • getAssociatedServingConfigIdsBytes

      public com.google.protobuf.ByteString getAssociatedServingConfigIdsBytes(int index)
       Output only. List of [serving
 config][google.cloud.retail.v2alpha.ServingConfig] ids that are associated
 with this control in the same
 [Catalog][google.cloud.retail.v2alpha.Catalog].

 Note the association is managed via the
 [ServingConfig][google.cloud.retail.v2alpha.ServingConfig], this is an
 output only denormalized view.
      repeated string associated_serving_config_ids = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAssociatedServingConfigIdsBytes in interface ControlOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the associatedServingConfigIds at the given index.

    • setAssociatedServingConfigIds

      public Control.Builder setAssociatedServingConfigIds(int index, String value)
       Output only. List of [serving
 config][google.cloud.retail.v2alpha.ServingConfig] ids that are associated
 with this control in the same
 [Catalog][google.cloud.retail.v2alpha.Catalog].

 Note the association is managed via the
 [ServingConfig][google.cloud.retail.v2alpha.ServingConfig], this is an
 output only denormalized view.
      repeated string associated_serving_config_ids = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index to set the value at.
      value - The associatedServingConfigIds to set.
      Returns:
      This builder for chaining.

    • addAssociatedServingConfigIds

      public Control.Builder addAssociatedServingConfigIds(String value)
       Output only. List of [serving
 config][google.cloud.retail.v2alpha.ServingConfig] ids that are associated
 with this control in the same
 [Catalog][google.cloud.retail.v2alpha.Catalog].

 Note the association is managed via the
 [ServingConfig][google.cloud.retail.v2alpha.ServingConfig], this is an
 output only denormalized view.
      repeated string associated_serving_config_ids = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The associatedServingConfigIds to add.
      Returns:
      This builder for chaining.

    • addAllAssociatedServingConfigIds

      public Control.Builder addAllAssociatedServingConfigIds(Iterable<String> values)
       Output only. List of [serving
 config][google.cloud.retail.v2alpha.ServingConfig] ids that are associated
 with this control in the same
 [Catalog][google.cloud.retail.v2alpha.Catalog].

 Note the association is managed via the
 [ServingConfig][google.cloud.retail.v2alpha.ServingConfig], this is an
 output only denormalized view.
      repeated string associated_serving_config_ids = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      values - The associatedServingConfigIds to add.
      Returns:
      This builder for chaining.

    • clearAssociatedServingConfigIds

      public Control.Builder clearAssociatedServingConfigIds()
       Output only. List of [serving
 config][google.cloud.retail.v2alpha.ServingConfig] ids that are associated
 with this control in the same
 [Catalog][google.cloud.retail.v2alpha.Catalog].

 Note the association is managed via the
 [ServingConfig][google.cloud.retail.v2alpha.ServingConfig], this is an
 output only denormalized view.
      repeated string associated_serving_config_ids = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • addAssociatedServingConfigIdsBytes

      public Control.Builder addAssociatedServingConfigIdsBytes(com.google.protobuf.ByteString value)
       Output only. List of [serving
 config][google.cloud.retail.v2alpha.ServingConfig] ids that are associated
 with this control in the same
 [Catalog][google.cloud.retail.v2alpha.Catalog].

 Note the association is managed via the
 [ServingConfig][google.cloud.retail.v2alpha.ServingConfig], this is an
 output only denormalized view.
      repeated string associated_serving_config_ids = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The bytes of the associatedServingConfigIds to add.
      Returns:
      This builder for chaining.

    • getSolutionTypesList

      public List<SolutionType> getSolutionTypesList()
       Required. Immutable. The solution types that the control is used for.
 Currently we support setting only one type of solution at creation time.

 Only `SOLUTION_TYPE_SEARCH` value is supported at the moment.
 If no solution type is provided at creation time, will default to
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
      repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getSolutionTypesList in interface ControlOrBuilder
      Returns:
      A list containing the solutionTypes.

    • getSolutionTypesCount

      public int getSolutionTypesCount()
       Required. Immutable. The solution types that the control is used for.
 Currently we support setting only one type of solution at creation time.

 Only `SOLUTION_TYPE_SEARCH` value is supported at the moment.
 If no solution type is provided at creation time, will default to
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
      repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getSolutionTypesCount in interface ControlOrBuilder
      Returns:
      The count of solutionTypes.

    • getSolutionTypes

      public SolutionType getSolutionTypes(int index)
       Required. Immutable. The solution types that the control is used for.
 Currently we support setting only one type of solution at creation time.

 Only `SOLUTION_TYPE_SEARCH` value is supported at the moment.
 If no solution type is provided at creation time, will default to
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
      repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getSolutionTypes in interface ControlOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The solutionTypes at the given index.

    • setSolutionTypes

      public Control.Builder setSolutionTypes(int index, SolutionType value)
       Required. Immutable. The solution types that the control is used for.
 Currently we support setting only one type of solution at creation time.

 Only `SOLUTION_TYPE_SEARCH` value is supported at the moment.
 If no solution type is provided at creation time, will default to
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
      repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      index - The index to set the value at.
      value - The solutionTypes to set.
      Returns:
      This builder for chaining.

    • addSolutionTypes

      public Control.Builder addSolutionTypes(SolutionType value)
       Required. Immutable. The solution types that the control is used for.
 Currently we support setting only one type of solution at creation time.

 Only `SOLUTION_TYPE_SEARCH` value is supported at the moment.
 If no solution type is provided at creation time, will default to
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
      repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The solutionTypes to add.
      Returns:
      This builder for chaining.

    • addAllSolutionTypes

      public Control.Builder addAllSolutionTypes(Iterable<? extends SolutionType> values)
       Required. Immutable. The solution types that the control is used for.
 Currently we support setting only one type of solution at creation time.

 Only `SOLUTION_TYPE_SEARCH` value is supported at the moment.
 If no solution type is provided at creation time, will default to
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
      repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      values - The solutionTypes to add.
      Returns:
      This builder for chaining.

    • clearSolutionTypes

      public Control.Builder clearSolutionTypes()
       Required. Immutable. The solution types that the control is used for.
 Currently we support setting only one type of solution at creation time.

 Only `SOLUTION_TYPE_SEARCH` value is supported at the moment.
 If no solution type is provided at creation time, will default to
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
      repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Returns:
      This builder for chaining.

    • getSolutionTypesValueList

      public List<Integer> getSolutionTypesValueList()
       Required. Immutable. The solution types that the control is used for.
 Currently we support setting only one type of solution at creation time.

 Only `SOLUTION_TYPE_SEARCH` value is supported at the moment.
 If no solution type is provided at creation time, will default to
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
      repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getSolutionTypesValueList in interface ControlOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for solutionTypes.

    • getSolutionTypesValue

      public int getSolutionTypesValue(int index)
       Required. Immutable. The solution types that the control is used for.
 Currently we support setting only one type of solution at creation time.

 Only `SOLUTION_TYPE_SEARCH` value is supported at the moment.
 If no solution type is provided at creation time, will default to
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
      repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getSolutionTypesValue in interface ControlOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of solutionTypes at the given index.

    • setSolutionTypesValue

      public Control.Builder setSolutionTypesValue(int index, int value)
       Required. Immutable. The solution types that the control is used for.
 Currently we support setting only one type of solution at creation time.

 Only `SOLUTION_TYPE_SEARCH` value is supported at the moment.
 If no solution type is provided at creation time, will default to
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
      repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      index - The index to set the value at.
      value - The enum numeric value on the wire for solutionTypes to set.
      Returns:
      This builder for chaining.

    • addSolutionTypesValue

      public Control.Builder addSolutionTypesValue(int value)
       Required. Immutable. The solution types that the control is used for.
 Currently we support setting only one type of solution at creation time.

 Only `SOLUTION_TYPE_SEARCH` value is supported at the moment.
 If no solution type is provided at creation time, will default to
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
      repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The enum numeric value on the wire for solutionTypes to add.
      Returns:
      This builder for chaining.

    • addAllSolutionTypesValue

      public Control.Builder addAllSolutionTypesValue(Iterable<Integer> values)
       Required. Immutable. The solution types that the control is used for.
 Currently we support setting only one type of solution at creation time.

 Only `SOLUTION_TYPE_SEARCH` value is supported at the moment.
 If no solution type is provided at creation time, will default to
 [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH].
      repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      values - The enum numeric values on the wire for solutionTypes to add.
      Returns:
      This builder for chaining.

    • getSearchSolutionUseCaseList

      public List<SearchSolutionUseCase> getSearchSolutionUseCaseList()
       Specifies the use case for the control.
 Affects what condition fields can be set.
 Only settable by search controls.
 Will default to
 [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2alpha.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH]
 if not specified. Currently only allow one search_solution_use_case per
 control.
      repeated .google.cloud.retail.v2alpha.SearchSolutionUseCase search_solution_use_case = 7;
      Specified by:
      getSearchSolutionUseCaseList in interface ControlOrBuilder
      Returns:
      A list containing the searchSolutionUseCase.

    • getSearchSolutionUseCaseCount

      public int getSearchSolutionUseCaseCount()
       Specifies the use case for the control.
 Affects what condition fields can be set.
 Only settable by search controls.
 Will default to
 [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2alpha.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH]
 if not specified. Currently only allow one search_solution_use_case per
 control.
      repeated .google.cloud.retail.v2alpha.SearchSolutionUseCase search_solution_use_case = 7;
      Specified by:
      getSearchSolutionUseCaseCount in interface ControlOrBuilder
      Returns:
      The count of searchSolutionUseCase.

    • getSearchSolutionUseCase

      public SearchSolutionUseCase getSearchSolutionUseCase(int index)
       Specifies the use case for the control.
 Affects what condition fields can be set.
 Only settable by search controls.
 Will default to
 [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2alpha.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH]
 if not specified. Currently only allow one search_solution_use_case per
 control.
      repeated .google.cloud.retail.v2alpha.SearchSolutionUseCase search_solution_use_case = 7;
      Specified by:
      getSearchSolutionUseCase in interface ControlOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The searchSolutionUseCase at the given index.

    • setSearchSolutionUseCase

      public Control.Builder setSearchSolutionUseCase(int index, SearchSolutionUseCase value)
       Specifies the use case for the control.
 Affects what condition fields can be set.
 Only settable by search controls.
 Will default to
 [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2alpha.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH]
 if not specified. Currently only allow one search_solution_use_case per
 control.
      repeated .google.cloud.retail.v2alpha.SearchSolutionUseCase search_solution_use_case = 7;
      Parameters:
      index - The index to set the value at.
      value - The searchSolutionUseCase to set.
      Returns:
      This builder for chaining.

    • addSearchSolutionUseCase

      public Control.Builder addSearchSolutionUseCase(SearchSolutionUseCase value)
       Specifies the use case for the control.
 Affects what condition fields can be set.
 Only settable by search controls.
 Will default to
 [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2alpha.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH]
 if not specified. Currently only allow one search_solution_use_case per
 control.
      repeated .google.cloud.retail.v2alpha.SearchSolutionUseCase search_solution_use_case = 7;
      Parameters:
      value - The searchSolutionUseCase to add.
      Returns:
      This builder for chaining.

    • addAllSearchSolutionUseCase

      public Control.Builder addAllSearchSolutionUseCase(Iterable<? extends SearchSolutionUseCase> values)
       Specifies the use case for the control.
 Affects what condition fields can be set.
 Only settable by search controls.
 Will default to
 [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2alpha.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH]
 if not specified. Currently only allow one search_solution_use_case per
 control.
      repeated .google.cloud.retail.v2alpha.SearchSolutionUseCase search_solution_use_case = 7;
      Parameters:
      values - The searchSolutionUseCase to add.
      Returns:
      This builder for chaining.

    • clearSearchSolutionUseCase

      public Control.Builder clearSearchSolutionUseCase()
       Specifies the use case for the control.
 Affects what condition fields can be set.
 Only settable by search controls.
 Will default to
 [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2alpha.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH]
 if not specified. Currently only allow one search_solution_use_case per
 control.
      repeated .google.cloud.retail.v2alpha.SearchSolutionUseCase search_solution_use_case = 7;
      Returns:
      This builder for chaining.

    • getSearchSolutionUseCaseValueList

      public List<Integer> getSearchSolutionUseCaseValueList()
       Specifies the use case for the control.
 Affects what condition fields can be set.
 Only settable by search controls.
 Will default to
 [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2alpha.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH]
 if not specified. Currently only allow one search_solution_use_case per
 control.
      repeated .google.cloud.retail.v2alpha.SearchSolutionUseCase search_solution_use_case = 7;
      Specified by:
      getSearchSolutionUseCaseValueList in interface ControlOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for searchSolutionUseCase.

    • getSearchSolutionUseCaseValue

      public int getSearchSolutionUseCaseValue(int index)
       Specifies the use case for the control.
 Affects what condition fields can be set.
 Only settable by search controls.
 Will default to
 [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2alpha.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH]
 if not specified. Currently only allow one search_solution_use_case per
 control.
      repeated .google.cloud.retail.v2alpha.SearchSolutionUseCase search_solution_use_case = 7;
      Specified by:
      getSearchSolutionUseCaseValue in interface ControlOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of searchSolutionUseCase at the given index.

    • setSearchSolutionUseCaseValue

      public Control.Builder setSearchSolutionUseCaseValue(int index, int value)
       Specifies the use case for the control.
 Affects what condition fields can be set.
 Only settable by search controls.
 Will default to
 [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2alpha.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH]
 if not specified. Currently only allow one search_solution_use_case per
 control.
      repeated .google.cloud.retail.v2alpha.SearchSolutionUseCase search_solution_use_case = 7;
      Parameters:
      index - The index to set the value at.
      value - The enum numeric value on the wire for searchSolutionUseCase to set.
      Returns:
      This builder for chaining.

    • addSearchSolutionUseCaseValue

      public Control.Builder addSearchSolutionUseCaseValue(int value)
       Specifies the use case for the control.
 Affects what condition fields can be set.
 Only settable by search controls.
 Will default to
 [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2alpha.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH]
 if not specified. Currently only allow one search_solution_use_case per
 control.
      repeated .google.cloud.retail.v2alpha.SearchSolutionUseCase search_solution_use_case = 7;
      Parameters:
      value - The enum numeric value on the wire for searchSolutionUseCase to add.
      Returns:
      This builder for chaining.

    • addAllSearchSolutionUseCaseValue

      public Control.Builder addAllSearchSolutionUseCaseValue(Iterable<Integer> values)
       Specifies the use case for the control.
 Affects what condition fields can be set.
 Only settable by search controls.
 Will default to
 [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2alpha.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH]
 if not specified. Currently only allow one search_solution_use_case per
 control.
      repeated .google.cloud.retail.v2alpha.SearchSolutionUseCase search_solution_use_case = 7;
      Parameters:
      values - The enum numeric values on the wire for searchSolutionUseCase to add.
      Returns:
      This builder for chaining.