Class CatalogItem.Builder

  • All Implemented Interfaces:
    CatalogItemOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    CatalogItem

    public static final class CatalogItem.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<CatalogItem.Builder>
    implements CatalogItemOrBuilder
     CatalogItem captures all metadata information of items to be recommended.
     
    Protobuf type google.cloud.recommendationengine.v1beta1.CatalogItem
    • Method Detail

      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<CatalogItem.Builder>
      • clear

        public CatalogItem.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.GeneratedMessageV3.Builder<CatalogItem.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.GeneratedMessageV3.Builder<CatalogItem.Builder>
      • getDefaultInstanceForType

        public CatalogItem getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

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

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

        public CatalogItem.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<CatalogItem.Builder>
      • setField

        public CatalogItem.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<CatalogItem.Builder>
      • clearField

        public CatalogItem.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<CatalogItem.Builder>
      • clearOneof

        public CatalogItem.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<CatalogItem.Builder>
      • setRepeatedField

        public CatalogItem.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    int index,
                                                    Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CatalogItem.Builder>
      • addRepeatedField

        public CatalogItem.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CatalogItem.Builder>
      • mergeFrom

        public CatalogItem.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<CatalogItem.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<CatalogItem.Builder>
      • mergeFrom

        public CatalogItem.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<CatalogItem.Builder>
        Throws:
        IOException
      • getId

        public String getId()
         Required. Catalog item identifier. UTF-8 encoded string with a length limit
         of 128 bytes.
        
         This id must be unique among all catalog items within the same catalog. It
         should also be used when logging user events in order for the user events
         to be joined with the Catalog.
         
        string id = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getId in interface CatalogItemOrBuilder
        Returns:
        The id.
      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         Required. Catalog item identifier. UTF-8 encoded string with a length limit
         of 128 bytes.
        
         This id must be unique among all catalog items within the same catalog. It
         should also be used when logging user events in order for the user events
         to be joined with the Catalog.
         
        string id = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getIdBytes in interface CatalogItemOrBuilder
        Returns:
        The bytes for id.
      • setId

        public CatalogItem.Builder setId​(String value)
         Required. Catalog item identifier. UTF-8 encoded string with a length limit
         of 128 bytes.
        
         This id must be unique among all catalog items within the same catalog. It
         should also be used when logging user events in order for the user events
         to be joined with the Catalog.
         
        string id = 1 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The id to set.
        Returns:
        This builder for chaining.
      • clearId

        public CatalogItem.Builder clearId()
         Required. Catalog item identifier. UTF-8 encoded string with a length limit
         of 128 bytes.
        
         This id must be unique among all catalog items within the same catalog. It
         should also be used when logging user events in order for the user events
         to be joined with the Catalog.
         
        string id = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.
      • setIdBytes

        public CatalogItem.Builder setIdBytes​(com.google.protobuf.ByteString value)
         Required. Catalog item identifier. UTF-8 encoded string with a length limit
         of 128 bytes.
        
         This id must be unique among all catalog items within the same catalog. It
         should also be used when logging user events in order for the user events
         to be joined with the Catalog.
         
        string id = 1 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for id to set.
        Returns:
        This builder for chaining.
      • getCategoryHierarchiesList

        public List<CatalogItem.CategoryHierarchy> getCategoryHierarchiesList()
         Required. Catalog item categories. This field is repeated for supporting
         one catalog item belonging to several parallel category hierarchies.
        
         For example, if a shoes product belongs to both
         ["Shoes & Accessories" -> "Shoes"] and
         ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be
         represented as:
        
              "categoryHierarchies": [
                { "categories": ["Shoes & Accessories", "Shoes"]},
                { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] }
              ]
         
        repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy category_hierarchies = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getCategoryHierarchiesList in interface CatalogItemOrBuilder
      • getCategoryHierarchiesCount

        public int getCategoryHierarchiesCount()
         Required. Catalog item categories. This field is repeated for supporting
         one catalog item belonging to several parallel category hierarchies.
        
         For example, if a shoes product belongs to both
         ["Shoes & Accessories" -> "Shoes"] and
         ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be
         represented as:
        
              "categoryHierarchies": [
                { "categories": ["Shoes & Accessories", "Shoes"]},
                { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] }
              ]
         
        repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy category_hierarchies = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getCategoryHierarchiesCount in interface CatalogItemOrBuilder
      • getCategoryHierarchies

        public CatalogItem.CategoryHierarchy getCategoryHierarchies​(int index)
         Required. Catalog item categories. This field is repeated for supporting
         one catalog item belonging to several parallel category hierarchies.
        
         For example, if a shoes product belongs to both
         ["Shoes & Accessories" -> "Shoes"] and
         ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be
         represented as:
        
              "categoryHierarchies": [
                { "categories": ["Shoes & Accessories", "Shoes"]},
                { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] }
              ]
         
        repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy category_hierarchies = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getCategoryHierarchies in interface CatalogItemOrBuilder
      • setCategoryHierarchies

        public CatalogItem.Builder setCategoryHierarchies​(int index,
                                                          CatalogItem.CategoryHierarchy value)
         Required. Catalog item categories. This field is repeated for supporting
         one catalog item belonging to several parallel category hierarchies.
        
         For example, if a shoes product belongs to both
         ["Shoes & Accessories" -> "Shoes"] and
         ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be
         represented as:
        
              "categoryHierarchies": [
                { "categories": ["Shoes & Accessories", "Shoes"]},
                { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] }
              ]
         
        repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy category_hierarchies = 2 [(.google.api.field_behavior) = REQUIRED];
      • setCategoryHierarchies

        public CatalogItem.Builder setCategoryHierarchies​(int index,
                                                          CatalogItem.CategoryHierarchy.Builder builderForValue)
         Required. Catalog item categories. This field is repeated for supporting
         one catalog item belonging to several parallel category hierarchies.
        
         For example, if a shoes product belongs to both
         ["Shoes & Accessories" -> "Shoes"] and
         ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be
         represented as:
        
              "categoryHierarchies": [
                { "categories": ["Shoes & Accessories", "Shoes"]},
                { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] }
              ]
         
        repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy category_hierarchies = 2 [(.google.api.field_behavior) = REQUIRED];
      • addCategoryHierarchies

        public CatalogItem.Builder addCategoryHierarchies​(CatalogItem.CategoryHierarchy value)
         Required. Catalog item categories. This field is repeated for supporting
         one catalog item belonging to several parallel category hierarchies.
        
         For example, if a shoes product belongs to both
         ["Shoes & Accessories" -> "Shoes"] and
         ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be
         represented as:
        
              "categoryHierarchies": [
                { "categories": ["Shoes & Accessories", "Shoes"]},
                { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] }
              ]
         
        repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy category_hierarchies = 2 [(.google.api.field_behavior) = REQUIRED];
      • addCategoryHierarchies

        public CatalogItem.Builder addCategoryHierarchies​(int index,
                                                          CatalogItem.CategoryHierarchy value)
         Required. Catalog item categories. This field is repeated for supporting
         one catalog item belonging to several parallel category hierarchies.
        
         For example, if a shoes product belongs to both
         ["Shoes & Accessories" -> "Shoes"] and
         ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be
         represented as:
        
              "categoryHierarchies": [
                { "categories": ["Shoes & Accessories", "Shoes"]},
                { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] }
              ]
         
        repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy category_hierarchies = 2 [(.google.api.field_behavior) = REQUIRED];
      • addCategoryHierarchies

        public CatalogItem.Builder addCategoryHierarchies​(CatalogItem.CategoryHierarchy.Builder builderForValue)
         Required. Catalog item categories. This field is repeated for supporting
         one catalog item belonging to several parallel category hierarchies.
        
         For example, if a shoes product belongs to both
         ["Shoes & Accessories" -> "Shoes"] and
         ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be
         represented as:
        
              "categoryHierarchies": [
                { "categories": ["Shoes & Accessories", "Shoes"]},
                { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] }
              ]
         
        repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy category_hierarchies = 2 [(.google.api.field_behavior) = REQUIRED];
      • addCategoryHierarchies

        public CatalogItem.Builder addCategoryHierarchies​(int index,
                                                          CatalogItem.CategoryHierarchy.Builder builderForValue)
         Required. Catalog item categories. This field is repeated for supporting
         one catalog item belonging to several parallel category hierarchies.
        
         For example, if a shoes product belongs to both
         ["Shoes & Accessories" -> "Shoes"] and
         ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be
         represented as:
        
              "categoryHierarchies": [
                { "categories": ["Shoes & Accessories", "Shoes"]},
                { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] }
              ]
         
        repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy category_hierarchies = 2 [(.google.api.field_behavior) = REQUIRED];
      • addAllCategoryHierarchies

        public CatalogItem.Builder addAllCategoryHierarchies​(Iterable<? extends CatalogItem.CategoryHierarchy> values)
         Required. Catalog item categories. This field is repeated for supporting
         one catalog item belonging to several parallel category hierarchies.
        
         For example, if a shoes product belongs to both
         ["Shoes & Accessories" -> "Shoes"] and
         ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be
         represented as:
        
              "categoryHierarchies": [
                { "categories": ["Shoes & Accessories", "Shoes"]},
                { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] }
              ]
         
        repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy category_hierarchies = 2 [(.google.api.field_behavior) = REQUIRED];
      • clearCategoryHierarchies

        public CatalogItem.Builder clearCategoryHierarchies()
         Required. Catalog item categories. This field is repeated for supporting
         one catalog item belonging to several parallel category hierarchies.
        
         For example, if a shoes product belongs to both
         ["Shoes & Accessories" -> "Shoes"] and
         ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be
         represented as:
        
              "categoryHierarchies": [
                { "categories": ["Shoes & Accessories", "Shoes"]},
                { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] }
              ]
         
        repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy category_hierarchies = 2 [(.google.api.field_behavior) = REQUIRED];
      • removeCategoryHierarchies

        public CatalogItem.Builder removeCategoryHierarchies​(int index)
         Required. Catalog item categories. This field is repeated for supporting
         one catalog item belonging to several parallel category hierarchies.
        
         For example, if a shoes product belongs to both
         ["Shoes & Accessories" -> "Shoes"] and
         ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be
         represented as:
        
              "categoryHierarchies": [
                { "categories": ["Shoes & Accessories", "Shoes"]},
                { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] }
              ]
         
        repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy category_hierarchies = 2 [(.google.api.field_behavior) = REQUIRED];
      • getCategoryHierarchiesBuilder

        public CatalogItem.CategoryHierarchy.Builder getCategoryHierarchiesBuilder​(int index)
         Required. Catalog item categories. This field is repeated for supporting
         one catalog item belonging to several parallel category hierarchies.
        
         For example, if a shoes product belongs to both
         ["Shoes & Accessories" -> "Shoes"] and
         ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be
         represented as:
        
              "categoryHierarchies": [
                { "categories": ["Shoes & Accessories", "Shoes"]},
                { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] }
              ]
         
        repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy category_hierarchies = 2 [(.google.api.field_behavior) = REQUIRED];
      • getCategoryHierarchiesOrBuilder

        public CatalogItem.CategoryHierarchyOrBuilder getCategoryHierarchiesOrBuilder​(int index)
         Required. Catalog item categories. This field is repeated for supporting
         one catalog item belonging to several parallel category hierarchies.
        
         For example, if a shoes product belongs to both
         ["Shoes & Accessories" -> "Shoes"] and
         ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be
         represented as:
        
              "categoryHierarchies": [
                { "categories": ["Shoes & Accessories", "Shoes"]},
                { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] }
              ]
         
        repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy category_hierarchies = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getCategoryHierarchiesOrBuilder in interface CatalogItemOrBuilder
      • getCategoryHierarchiesOrBuilderList

        public List<? extends CatalogItem.CategoryHierarchyOrBuilder> getCategoryHierarchiesOrBuilderList()
         Required. Catalog item categories. This field is repeated for supporting
         one catalog item belonging to several parallel category hierarchies.
        
         For example, if a shoes product belongs to both
         ["Shoes & Accessories" -> "Shoes"] and
         ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be
         represented as:
        
              "categoryHierarchies": [
                { "categories": ["Shoes & Accessories", "Shoes"]},
                { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] }
              ]
         
        repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy category_hierarchies = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getCategoryHierarchiesOrBuilderList in interface CatalogItemOrBuilder
      • addCategoryHierarchiesBuilder

        public CatalogItem.CategoryHierarchy.Builder addCategoryHierarchiesBuilder()
         Required. Catalog item categories. This field is repeated for supporting
         one catalog item belonging to several parallel category hierarchies.
        
         For example, if a shoes product belongs to both
         ["Shoes & Accessories" -> "Shoes"] and
         ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be
         represented as:
        
              "categoryHierarchies": [
                { "categories": ["Shoes & Accessories", "Shoes"]},
                { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] }
              ]
         
        repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy category_hierarchies = 2 [(.google.api.field_behavior) = REQUIRED];
      • addCategoryHierarchiesBuilder

        public CatalogItem.CategoryHierarchy.Builder addCategoryHierarchiesBuilder​(int index)
         Required. Catalog item categories. This field is repeated for supporting
         one catalog item belonging to several parallel category hierarchies.
        
         For example, if a shoes product belongs to both
         ["Shoes & Accessories" -> "Shoes"] and
         ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be
         represented as:
        
              "categoryHierarchies": [
                { "categories": ["Shoes & Accessories", "Shoes"]},
                { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] }
              ]
         
        repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy category_hierarchies = 2 [(.google.api.field_behavior) = REQUIRED];
      • getCategoryHierarchiesBuilderList

        public List<CatalogItem.CategoryHierarchy.Builder> getCategoryHierarchiesBuilderList()
         Required. Catalog item categories. This field is repeated for supporting
         one catalog item belonging to several parallel category hierarchies.
        
         For example, if a shoes product belongs to both
         ["Shoes & Accessories" -> "Shoes"] and
         ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be
         represented as:
        
              "categoryHierarchies": [
                { "categories": ["Shoes & Accessories", "Shoes"]},
                { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] }
              ]
         
        repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy category_hierarchies = 2 [(.google.api.field_behavior) = REQUIRED];
      • getTitle

        public String getTitle()
         Required. Catalog item title. UTF-8 encoded string with a length limit of 1
         KiB.
         
        string title = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTitle in interface CatalogItemOrBuilder
        Returns:
        The title.
      • getTitleBytes

        public com.google.protobuf.ByteString getTitleBytes()
         Required. Catalog item title. UTF-8 encoded string with a length limit of 1
         KiB.
         
        string title = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTitleBytes in interface CatalogItemOrBuilder
        Returns:
        The bytes for title.
      • setTitle

        public CatalogItem.Builder setTitle​(String value)
         Required. Catalog item title. UTF-8 encoded string with a length limit of 1
         KiB.
         
        string title = 3 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The title to set.
        Returns:
        This builder for chaining.
      • clearTitle

        public CatalogItem.Builder clearTitle()
         Required. Catalog item title. UTF-8 encoded string with a length limit of 1
         KiB.
         
        string title = 3 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.
      • setTitleBytes

        public CatalogItem.Builder setTitleBytes​(com.google.protobuf.ByteString value)
         Required. Catalog item title. UTF-8 encoded string with a length limit of 1
         KiB.
         
        string title = 3 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for title to set.
        Returns:
        This builder for chaining.
      • getDescription

        public String getDescription()
         Optional. Catalog item description. UTF-8 encoded string with a length
         limit of 5 KiB.
         
        string description = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDescription in interface CatalogItemOrBuilder
        Returns:
        The description.
      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Optional. Catalog item description. UTF-8 encoded string with a length
         limit of 5 KiB.
         
        string description = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDescriptionBytes in interface CatalogItemOrBuilder
        Returns:
        The bytes for description.
      • setDescription

        public CatalogItem.Builder setDescription​(String value)
         Optional. Catalog item description. UTF-8 encoded string with a length
         limit of 5 KiB.
         
        string description = 4 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The description to set.
        Returns:
        This builder for chaining.
      • clearDescription

        public CatalogItem.Builder clearDescription()
         Optional. Catalog item description. UTF-8 encoded string with a length
         limit of 5 KiB.
         
        string description = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.
      • setDescriptionBytes

        public CatalogItem.Builder setDescriptionBytes​(com.google.protobuf.ByteString value)
         Optional. Catalog item description. UTF-8 encoded string with a length
         limit of 5 KiB.
         
        string description = 4 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for description to set.
        Returns:
        This builder for chaining.
      • hasItemAttributes

        public boolean hasItemAttributes()
         Optional. Highly encouraged. Extra catalog item attributes to be
         included in the recommendation model. For example, for retail products,
         this could include the store name, vendor, style, color, etc. These are
         very strong signals for recommendation model, thus we highly recommend
         providing the item attributes here.
         
        .google.cloud.recommendationengine.v1beta1.FeatureMap item_attributes = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasItemAttributes in interface CatalogItemOrBuilder
        Returns:
        Whether the itemAttributes field is set.
      • getItemAttributes

        public FeatureMap getItemAttributes()
         Optional. Highly encouraged. Extra catalog item attributes to be
         included in the recommendation model. For example, for retail products,
         this could include the store name, vendor, style, color, etc. These are
         very strong signals for recommendation model, thus we highly recommend
         providing the item attributes here.
         
        .google.cloud.recommendationengine.v1beta1.FeatureMap item_attributes = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getItemAttributes in interface CatalogItemOrBuilder
        Returns:
        The itemAttributes.
      • setItemAttributes

        public CatalogItem.Builder setItemAttributes​(FeatureMap value)
         Optional. Highly encouraged. Extra catalog item attributes to be
         included in the recommendation model. For example, for retail products,
         this could include the store name, vendor, style, color, etc. These are
         very strong signals for recommendation model, thus we highly recommend
         providing the item attributes here.
         
        .google.cloud.recommendationengine.v1beta1.FeatureMap item_attributes = 5 [(.google.api.field_behavior) = OPTIONAL];
      • setItemAttributes

        public CatalogItem.Builder setItemAttributes​(FeatureMap.Builder builderForValue)
         Optional. Highly encouraged. Extra catalog item attributes to be
         included in the recommendation model. For example, for retail products,
         this could include the store name, vendor, style, color, etc. These are
         very strong signals for recommendation model, thus we highly recommend
         providing the item attributes here.
         
        .google.cloud.recommendationengine.v1beta1.FeatureMap item_attributes = 5 [(.google.api.field_behavior) = OPTIONAL];
      • mergeItemAttributes

        public CatalogItem.Builder mergeItemAttributes​(FeatureMap value)
         Optional. Highly encouraged. Extra catalog item attributes to be
         included in the recommendation model. For example, for retail products,
         this could include the store name, vendor, style, color, etc. These are
         very strong signals for recommendation model, thus we highly recommend
         providing the item attributes here.
         
        .google.cloud.recommendationengine.v1beta1.FeatureMap item_attributes = 5 [(.google.api.field_behavior) = OPTIONAL];
      • clearItemAttributes

        public CatalogItem.Builder clearItemAttributes()
         Optional. Highly encouraged. Extra catalog item attributes to be
         included in the recommendation model. For example, for retail products,
         this could include the store name, vendor, style, color, etc. These are
         very strong signals for recommendation model, thus we highly recommend
         providing the item attributes here.
         
        .google.cloud.recommendationengine.v1beta1.FeatureMap item_attributes = 5 [(.google.api.field_behavior) = OPTIONAL];
      • getItemAttributesBuilder

        public FeatureMap.Builder getItemAttributesBuilder()
         Optional. Highly encouraged. Extra catalog item attributes to be
         included in the recommendation model. For example, for retail products,
         this could include the store name, vendor, style, color, etc. These are
         very strong signals for recommendation model, thus we highly recommend
         providing the item attributes here.
         
        .google.cloud.recommendationengine.v1beta1.FeatureMap item_attributes = 5 [(.google.api.field_behavior) = OPTIONAL];
      • getItemAttributesOrBuilder

        public FeatureMapOrBuilder getItemAttributesOrBuilder()
         Optional. Highly encouraged. Extra catalog item attributes to be
         included in the recommendation model. For example, for retail products,
         this could include the store name, vendor, style, color, etc. These are
         very strong signals for recommendation model, thus we highly recommend
         providing the item attributes here.
         
        .google.cloud.recommendationengine.v1beta1.FeatureMap item_attributes = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getItemAttributesOrBuilder in interface CatalogItemOrBuilder
      • getLanguageCode

        public String getLanguageCode()
         Optional. Language of the title/description/item_attributes. Use language
         tags defined by BCP 47. https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Our
         supported language codes include 'en', 'es', 'fr', 'de', 'ar', 'fa', 'zh',
         'ja', 'ko', 'sv', 'ro', 'nl'. For other languages, contact
         your Google account manager.
         
        string language_code = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLanguageCode in interface CatalogItemOrBuilder
        Returns:
        The languageCode.
      • getLanguageCodeBytes

        public com.google.protobuf.ByteString getLanguageCodeBytes()
         Optional. Language of the title/description/item_attributes. Use language
         tags defined by BCP 47. https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Our
         supported language codes include 'en', 'es', 'fr', 'de', 'ar', 'fa', 'zh',
         'ja', 'ko', 'sv', 'ro', 'nl'. For other languages, contact
         your Google account manager.
         
        string language_code = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLanguageCodeBytes in interface CatalogItemOrBuilder
        Returns:
        The bytes for languageCode.
      • setLanguageCode

        public CatalogItem.Builder setLanguageCode​(String value)
         Optional. Language of the title/description/item_attributes. Use language
         tags defined by BCP 47. https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Our
         supported language codes include 'en', 'es', 'fr', 'de', 'ar', 'fa', 'zh',
         'ja', 'ko', 'sv', 'ro', 'nl'. For other languages, contact
         your Google account manager.
         
        string language_code = 6 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The languageCode to set.
        Returns:
        This builder for chaining.
      • clearLanguageCode

        public CatalogItem.Builder clearLanguageCode()
         Optional. Language of the title/description/item_attributes. Use language
         tags defined by BCP 47. https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Our
         supported language codes include 'en', 'es', 'fr', 'de', 'ar', 'fa', 'zh',
         'ja', 'ko', 'sv', 'ro', 'nl'. For other languages, contact
         your Google account manager.
         
        string language_code = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.
      • setLanguageCodeBytes

        public CatalogItem.Builder setLanguageCodeBytes​(com.google.protobuf.ByteString value)
         Optional. Language of the title/description/item_attributes. Use language
         tags defined by BCP 47. https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Our
         supported language codes include 'en', 'es', 'fr', 'de', 'ar', 'fa', 'zh',
         'ja', 'ko', 'sv', 'ro', 'nl'. For other languages, contact
         your Google account manager.
         
        string language_code = 6 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for languageCode to set.
        Returns:
        This builder for chaining.
      • getTagsList

        public com.google.protobuf.ProtocolStringList getTagsList()
         Optional. Filtering tags associated with the catalog item. Each tag should
         be a UTF-8 encoded string with a length limit of 1 KiB.
        
         This tag can be used for filtering recommendation results by passing the
         tag as part of the predict request filter.
         
        repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getTagsList in interface CatalogItemOrBuilder
        Returns:
        A list containing the tags.
      • getTagsCount

        public int getTagsCount()
         Optional. Filtering tags associated with the catalog item. Each tag should
         be a UTF-8 encoded string with a length limit of 1 KiB.
        
         This tag can be used for filtering recommendation results by passing the
         tag as part of the predict request filter.
         
        repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getTagsCount in interface CatalogItemOrBuilder
        Returns:
        The count of tags.
      • getTags

        public String getTags​(int index)
         Optional. Filtering tags associated with the catalog item. Each tag should
         be a UTF-8 encoded string with a length limit of 1 KiB.
        
         This tag can be used for filtering recommendation results by passing the
         tag as part of the predict request filter.
         
        repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getTags in interface CatalogItemOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The tags at the given index.
      • getTagsBytes

        public com.google.protobuf.ByteString getTagsBytes​(int index)
         Optional. Filtering tags associated with the catalog item. Each tag should
         be a UTF-8 encoded string with a length limit of 1 KiB.
        
         This tag can be used for filtering recommendation results by passing the
         tag as part of the predict request filter.
         
        repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getTagsBytes in interface CatalogItemOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the tags at the given index.
      • setTags

        public CatalogItem.Builder setTags​(int index,
                                           String value)
         Optional. Filtering tags associated with the catalog item. Each tag should
         be a UTF-8 encoded string with a length limit of 1 KiB.
        
         This tag can be used for filtering recommendation results by passing the
         tag as part of the predict request filter.
         
        repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        index - The index to set the value at.
        value - The tags to set.
        Returns:
        This builder for chaining.
      • addTags

        public CatalogItem.Builder addTags​(String value)
         Optional. Filtering tags associated with the catalog item. Each tag should
         be a UTF-8 encoded string with a length limit of 1 KiB.
        
         This tag can be used for filtering recommendation results by passing the
         tag as part of the predict request filter.
         
        repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The tags to add.
        Returns:
        This builder for chaining.
      • addAllTags

        public CatalogItem.Builder addAllTags​(Iterable<String> values)
         Optional. Filtering tags associated with the catalog item. Each tag should
         be a UTF-8 encoded string with a length limit of 1 KiB.
        
         This tag can be used for filtering recommendation results by passing the
         tag as part of the predict request filter.
         
        repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        values - The tags to add.
        Returns:
        This builder for chaining.
      • clearTags

        public CatalogItem.Builder clearTags()
         Optional. Filtering tags associated with the catalog item. Each tag should
         be a UTF-8 encoded string with a length limit of 1 KiB.
        
         This tag can be used for filtering recommendation results by passing the
         tag as part of the predict request filter.
         
        repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.
      • addTagsBytes

        public CatalogItem.Builder addTagsBytes​(com.google.protobuf.ByteString value)
         Optional. Filtering tags associated with the catalog item. Each tag should
         be a UTF-8 encoded string with a length limit of 1 KiB.
        
         This tag can be used for filtering recommendation results by passing the
         tag as part of the predict request filter.
         
        repeated string tags = 8 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes of the tags to add.
        Returns:
        This builder for chaining.
      • getItemGroupId

        public String getItemGroupId()
         Optional. Variant group identifier for prediction results. UTF-8 encoded
         string with a length limit of 128 bytes.
        
         This field must be enabled before it can be used. [Learn
         more](/recommendations-ai/docs/catalog#item-group-id).
         
        string item_group_id = 9 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getItemGroupId in interface CatalogItemOrBuilder
        Returns:
        The itemGroupId.
      • getItemGroupIdBytes

        public com.google.protobuf.ByteString getItemGroupIdBytes()
         Optional. Variant group identifier for prediction results. UTF-8 encoded
         string with a length limit of 128 bytes.
        
         This field must be enabled before it can be used. [Learn
         more](/recommendations-ai/docs/catalog#item-group-id).
         
        string item_group_id = 9 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getItemGroupIdBytes in interface CatalogItemOrBuilder
        Returns:
        The bytes for itemGroupId.
      • setItemGroupId

        public CatalogItem.Builder setItemGroupId​(String value)
         Optional. Variant group identifier for prediction results. UTF-8 encoded
         string with a length limit of 128 bytes.
        
         This field must be enabled before it can be used. [Learn
         more](/recommendations-ai/docs/catalog#item-group-id).
         
        string item_group_id = 9 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The itemGroupId to set.
        Returns:
        This builder for chaining.
      • clearItemGroupId

        public CatalogItem.Builder clearItemGroupId()
         Optional. Variant group identifier for prediction results. UTF-8 encoded
         string with a length limit of 128 bytes.
        
         This field must be enabled before it can be used. [Learn
         more](/recommendations-ai/docs/catalog#item-group-id).
         
        string item_group_id = 9 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.
      • setItemGroupIdBytes

        public CatalogItem.Builder setItemGroupIdBytes​(com.google.protobuf.ByteString value)
         Optional. Variant group identifier for prediction results. UTF-8 encoded
         string with a length limit of 128 bytes.
        
         This field must be enabled before it can be used. [Learn
         more](/recommendations-ai/docs/catalog#item-group-id).
         
        string item_group_id = 9 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for itemGroupId to set.
        Returns:
        This builder for chaining.
      • hasProductMetadata

        public boolean hasProductMetadata()
         Optional. Metadata specific to retail products.
         
        .google.cloud.recommendationengine.v1beta1.ProductCatalogItem product_metadata = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasProductMetadata in interface CatalogItemOrBuilder
        Returns:
        Whether the productMetadata field is set.
      • getProductMetadata

        public ProductCatalogItem getProductMetadata()
         Optional. Metadata specific to retail products.
         
        .google.cloud.recommendationengine.v1beta1.ProductCatalogItem product_metadata = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getProductMetadata in interface CatalogItemOrBuilder
        Returns:
        The productMetadata.
      • setProductMetadata

        public CatalogItem.Builder setProductMetadata​(ProductCatalogItem value)
         Optional. Metadata specific to retail products.
         
        .google.cloud.recommendationengine.v1beta1.ProductCatalogItem product_metadata = 10 [(.google.api.field_behavior) = OPTIONAL];
      • setProductMetadata

        public CatalogItem.Builder setProductMetadata​(ProductCatalogItem.Builder builderForValue)
         Optional. Metadata specific to retail products.
         
        .google.cloud.recommendationengine.v1beta1.ProductCatalogItem product_metadata = 10 [(.google.api.field_behavior) = OPTIONAL];
      • mergeProductMetadata

        public CatalogItem.Builder mergeProductMetadata​(ProductCatalogItem value)
         Optional. Metadata specific to retail products.
         
        .google.cloud.recommendationengine.v1beta1.ProductCatalogItem product_metadata = 10 [(.google.api.field_behavior) = OPTIONAL];
      • clearProductMetadata

        public CatalogItem.Builder clearProductMetadata()
         Optional. Metadata specific to retail products.
         
        .google.cloud.recommendationengine.v1beta1.ProductCatalogItem product_metadata = 10 [(.google.api.field_behavior) = OPTIONAL];
      • getProductMetadataBuilder

        public ProductCatalogItem.Builder getProductMetadataBuilder()
         Optional. Metadata specific to retail products.
         
        .google.cloud.recommendationengine.v1beta1.ProductCatalogItem product_metadata = 10 [(.google.api.field_behavior) = OPTIONAL];
      • setUnknownFields

        public final CatalogItem.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CatalogItem.Builder>
      • mergeUnknownFields

        public final CatalogItem.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CatalogItem.Builder>