Package com.google.cloud.recommendationengine.v1beta1

Class ProductDetail.Builder

  • All Implemented Interfaces:
    ProductDetailOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    ProductDetail
    public static final class ProductDetail.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ProductDetail.Builder>
implements ProductDetailOrBuilder
     Detailed product information associated with a user event.
    Protobuf type google.cloud.recommendationengine.v1beta1.ProductDetail

    • 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<ProductDetail.Builder>

      • clear

        public ProductDetail.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<ProductDetail.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<ProductDetail.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public ProductDetail.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<ProductDetail.Builder>

      • setField

        public ProductDetail.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<ProductDetail.Builder>

      • clearField

        public ProductDetail.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<ProductDetail.Builder>

      • clearOneof

        public ProductDetail.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<ProductDetail.Builder>

      • setRepeatedField

        public ProductDetail.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<ProductDetail.Builder>

      • addRepeatedField

        public ProductDetail.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<ProductDetail.Builder>

      • mergeFrom

        public ProductDetail.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<ProductDetail.Builder>

      • isInitialized

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

      • mergeFrom

        public ProductDetail.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<ProductDetail.Builder>
        Throws:
        IOException

      • getId

        public String getId()
         Required. Catalog item ID. UTF-8 encoded string with a length limit of 128
 characters.
        string id = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getId in interface ProductDetailOrBuilder
        Returns:
        The id.

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         Required. Catalog item ID. UTF-8 encoded string with a length limit of 128
 characters.
        string id = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getIdBytes in interface ProductDetailOrBuilder
        Returns:
        The bytes for id.

      • setId

        public ProductDetail.Builder setId​(String value)
         Required. Catalog item ID. UTF-8 encoded string with a length limit of 128
 characters.
        string id = 1 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The id to set.
        Returns:
        This builder for chaining.

      • clearId

        public ProductDetail.Builder clearId()
         Required. Catalog item ID. UTF-8 encoded string with a length limit of 128
 characters.
        string id = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • setIdBytes

        public ProductDetail.Builder setIdBytes​(com.google.protobuf.ByteString value)
         Required. Catalog item ID. UTF-8 encoded string with a length limit of 128
 characters.
        string id = 1 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for id to set.
        Returns:
        This builder for chaining.

      • getCurrencyCode

        public String getCurrencyCode()
         Optional. Currency code for price/costs. Use three-character ISO-4217
 code. Required only if originalPrice or displayPrice is set.
        string currency_code = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getCurrencyCode in interface ProductDetailOrBuilder
        Returns:
        The currencyCode.

      • getCurrencyCodeBytes

        public com.google.protobuf.ByteString getCurrencyCodeBytes()
         Optional. Currency code for price/costs. Use three-character ISO-4217
 code. Required only if originalPrice or displayPrice is set.
        string currency_code = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getCurrencyCodeBytes in interface ProductDetailOrBuilder
        Returns:
        The bytes for currencyCode.

      • setCurrencyCode

        public ProductDetail.Builder setCurrencyCode​(String value)
         Optional. Currency code for price/costs. Use three-character ISO-4217
 code. Required only if originalPrice or displayPrice is set.
        string currency_code = 2 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The currencyCode to set.
        Returns:
        This builder for chaining.

      • clearCurrencyCode

        public ProductDetail.Builder clearCurrencyCode()
         Optional. Currency code for price/costs. Use three-character ISO-4217
 code. Required only if originalPrice or displayPrice is set.
        string currency_code = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • setCurrencyCodeBytes

        public ProductDetail.Builder setCurrencyCodeBytes​(com.google.protobuf.ByteString value)
         Optional. Currency code for price/costs. Use three-character ISO-4217
 code. Required only if originalPrice or displayPrice is set.
        string currency_code = 2 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for currencyCode to set.
        Returns:
        This builder for chaining.

      • getOriginalPrice

        public float getOriginalPrice()
         Optional. Original price of the product. If provided, this will override
 the original price in Catalog for this product.
        float original_price = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getOriginalPrice in interface ProductDetailOrBuilder
        Returns:
        The originalPrice.

      • setOriginalPrice

        public ProductDetail.Builder setOriginalPrice​(float value)
         Optional. Original price of the product. If provided, this will override
 the original price in Catalog for this product.
        float original_price = 3 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The originalPrice to set.
        Returns:
        This builder for chaining.

      • clearOriginalPrice

        public ProductDetail.Builder clearOriginalPrice()
         Optional. Original price of the product. If provided, this will override
 the original price in Catalog for this product.
        float original_price = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • getDisplayPrice

        public float getDisplayPrice()
         Optional. Display price of the product (e.g. discounted price). If
 provided, this will override the display price in Catalog for this product.
        float display_price = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDisplayPrice in interface ProductDetailOrBuilder
        Returns:
        The displayPrice.

      • setDisplayPrice

        public ProductDetail.Builder setDisplayPrice​(float value)
         Optional. Display price of the product (e.g. discounted price). If
 provided, this will override the display price in Catalog for this product.
        float display_price = 4 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The displayPrice to set.
        Returns:
        This builder for chaining.

      • clearDisplayPrice

        public ProductDetail.Builder clearDisplayPrice()
         Optional. Display price of the product (e.g. discounted price). If
 provided, this will override the display price in Catalog for this product.
        float display_price = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • getStockStateValue

        public int getStockStateValue()
         Optional. Item stock state. If provided, this overrides the stock state
 in Catalog for items in this event.
        .google.cloud.recommendationengine.v1beta1.ProductCatalogItem.StockState stock_state = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getStockStateValue in interface ProductDetailOrBuilder
        Returns:
        The enum numeric value on the wire for stockState.

      • setStockStateValue

        public ProductDetail.Builder setStockStateValue​(int value)
         Optional. Item stock state. If provided, this overrides the stock state
 in Catalog for items in this event.
        .google.cloud.recommendationengine.v1beta1.ProductCatalogItem.StockState stock_state = 5 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The enum numeric value on the wire for stockState to set.
        Returns:
        This builder for chaining.

      • getStockState

        public ProductCatalogItem.StockState getStockState()
         Optional. Item stock state. If provided, this overrides the stock state
 in Catalog for items in this event.
        .google.cloud.recommendationengine.v1beta1.ProductCatalogItem.StockState stock_state = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getStockState in interface ProductDetailOrBuilder
        Returns:
        The stockState.

      • setStockState

        public ProductDetail.Builder setStockState​(ProductCatalogItem.StockState value)
         Optional. Item stock state. If provided, this overrides the stock state
 in Catalog for items in this event.
        .google.cloud.recommendationengine.v1beta1.ProductCatalogItem.StockState stock_state = 5 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The stockState to set.
        Returns:
        This builder for chaining.

      • clearStockState

        public ProductDetail.Builder clearStockState()
         Optional. Item stock state. If provided, this overrides the stock state
 in Catalog for items in this event.
        .google.cloud.recommendationengine.v1beta1.ProductCatalogItem.StockState stock_state = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • getQuantity

        public int getQuantity()
         Optional. Quantity of the product associated with the user event. For
 example, this field will be 2 if two products are added to the shopping
 cart for `add-to-cart` event. Required for `add-to-cart`, `add-to-list`,
 `remove-from-cart`, `checkout-start`, `purchase-complete`, `refund` event
 types.
        int32 quantity = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getQuantity in interface ProductDetailOrBuilder
        Returns:
        The quantity.

      • setQuantity

        public ProductDetail.Builder setQuantity​(int value)
         Optional. Quantity of the product associated with the user event. For
 example, this field will be 2 if two products are added to the shopping
 cart for `add-to-cart` event. Required for `add-to-cart`, `add-to-list`,
 `remove-from-cart`, `checkout-start`, `purchase-complete`, `refund` event
 types.
        int32 quantity = 6 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The quantity to set.
        Returns:
        This builder for chaining.

      • clearQuantity

        public ProductDetail.Builder clearQuantity()
         Optional. Quantity of the product associated with the user event. For
 example, this field will be 2 if two products are added to the shopping
 cart for `add-to-cart` event. Required for `add-to-cart`, `add-to-list`,
 `remove-from-cart`, `checkout-start`, `purchase-complete`, `refund` event
 types.
        int32 quantity = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • getAvailableQuantity

        public int getAvailableQuantity()
         Optional. Quantity of the products in stock when a user event happens.
 Optional. If provided, this overrides the available quantity in Catalog for
 this event. and can only be set if `stock_status` is set to `IN_STOCK`.

 Note that if an item is out of stock, you must set the `stock_state` field
 to be `OUT_OF_STOCK`. Leaving this field unspecified / as zero is not
 sufficient to mark the item out of stock.
        int32 available_quantity = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAvailableQuantity in interface ProductDetailOrBuilder
        Returns:
        The availableQuantity.

      • setAvailableQuantity

        public ProductDetail.Builder setAvailableQuantity​(int value)
         Optional. Quantity of the products in stock when a user event happens.
 Optional. If provided, this overrides the available quantity in Catalog for
 this event. and can only be set if `stock_status` is set to `IN_STOCK`.

 Note that if an item is out of stock, you must set the `stock_state` field
 to be `OUT_OF_STOCK`. Leaving this field unspecified / as zero is not
 sufficient to mark the item out of stock.
        int32 available_quantity = 7 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The availableQuantity to set.
        Returns:
        This builder for chaining.

      • clearAvailableQuantity

        public ProductDetail.Builder clearAvailableQuantity()
         Optional. Quantity of the products in stock when a user event happens.
 Optional. If provided, this overrides the available quantity in Catalog for
 this event. and can only be set if `stock_status` is set to `IN_STOCK`.

 Note that if an item is out of stock, you must set the `stock_state` field
 to be `OUT_OF_STOCK`. Leaving this field unspecified / as zero is not
 sufficient to mark the item out of stock.
        int32 available_quantity = 7 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • hasItemAttributes

        public boolean hasItemAttributes()
         Optional. Extra features associated with a product in the user event.
        .google.cloud.recommendationengine.v1beta1.FeatureMap item_attributes = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasItemAttributes in interface ProductDetailOrBuilder
        Returns:
        Whether the itemAttributes field is set.

      • getItemAttributes

        public FeatureMap getItemAttributes()
         Optional. Extra features associated with a product in the user event.
        .google.cloud.recommendationengine.v1beta1.FeatureMap item_attributes = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getItemAttributes in interface ProductDetailOrBuilder
        Returns:
        The itemAttributes.

      • setItemAttributes

        public ProductDetail.Builder setItemAttributes​(FeatureMap value)
         Optional. Extra features associated with a product in the user event.
        .google.cloud.recommendationengine.v1beta1.FeatureMap item_attributes = 8 [(.google.api.field_behavior) = OPTIONAL];

      • setItemAttributes

        public ProductDetail.Builder setItemAttributes​(FeatureMap.Builder builderForValue)
         Optional. Extra features associated with a product in the user event.
        .google.cloud.recommendationengine.v1beta1.FeatureMap item_attributes = 8 [(.google.api.field_behavior) = OPTIONAL];

      • mergeItemAttributes

        public ProductDetail.Builder mergeItemAttributes​(FeatureMap value)
         Optional. Extra features associated with a product in the user event.
        .google.cloud.recommendationengine.v1beta1.FeatureMap item_attributes = 8 [(.google.api.field_behavior) = OPTIONAL];

      • clearItemAttributes

        public ProductDetail.Builder clearItemAttributes()
         Optional. Extra features associated with a product in the user event.
        .google.cloud.recommendationengine.v1beta1.FeatureMap item_attributes = 8 [(.google.api.field_behavior) = OPTIONAL];

      • getItemAttributesBuilder

        public FeatureMap.Builder getItemAttributesBuilder()
         Optional. Extra features associated with a product in the user event.
        .google.cloud.recommendationengine.v1beta1.FeatureMap item_attributes = 8 [(.google.api.field_behavior) = OPTIONAL];

      • getItemAttributesOrBuilder

        public FeatureMapOrBuilder getItemAttributesOrBuilder()
         Optional. Extra features associated with a product in the user event.
        .google.cloud.recommendationengine.v1beta1.FeatureMap item_attributes = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getItemAttributesOrBuilder in interface ProductDetailOrBuilder

      • setUnknownFields

        public final ProductDetail.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<ProductDetail.Builder>

      • mergeUnknownFields

        public final ProductDetail.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<ProductDetail.Builder>