Package com.google.cloud.recommendationengine.v1beta1

Class ProductDetail

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.recommendationengine.v1beta1.ProductDetail
All Implemented Interfaces:
ProductDetailOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ProductDetail extends com.google.protobuf.GeneratedMessage implements ProductDetailOrBuilder
 Detailed product information associated with a user event.
Protobuf type google.cloud.recommendationengine.v1beta1.ProductDetail
See Also:

  • Field Details

    • ID_FIELD_NUMBER

      public static final int ID_FIELD_NUMBER
      See Also:

    • CURRENCY_CODE_FIELD_NUMBER

      public static final int CURRENCY_CODE_FIELD_NUMBER
      See Also:

    • ORIGINAL_PRICE_FIELD_NUMBER

      public static final int ORIGINAL_PRICE_FIELD_NUMBER
      See Also:

    • DISPLAY_PRICE_FIELD_NUMBER

      public static final int DISPLAY_PRICE_FIELD_NUMBER
      See Also:

    • STOCK_STATE_FIELD_NUMBER

      public static final int STOCK_STATE_FIELD_NUMBER
      See Also:

    • QUANTITY_FIELD_NUMBER

      public static final int QUANTITY_FIELD_NUMBER
      See Also:

    • AVAILABLE_QUANTITY_FIELD_NUMBER

      public static final int AVAILABLE_QUANTITY_FIELD_NUMBER
      See Also:

    • ITEM_ATTRIBUTES_FIELD_NUMBER

      public static final int ITEM_ATTRIBUTES_FIELD_NUMBER
      See Also:

  • 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

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

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

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

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

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

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

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

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

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

    • 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

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ProductDetail parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProductDetail parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProductDetail parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProductDetail parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProductDetail parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProductDetail parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProductDetail parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ProductDetail parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ProductDetail parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ProductDetail parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ProductDetail parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ProductDetail parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static ProductDetail.Builder newBuilder()

    • newBuilder

      public static ProductDetail.Builder newBuilder(ProductDetail prototype)

    • toBuilder

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

    • newBuilderForType

      protected ProductDetail.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ProductDetail getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ProductDetail> parser()

    • getParserForType

      public com.google.protobuf.Parser<ProductDetail> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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