Class ProductDetail (2.45.0)

public final class ProductDetail extends GeneratedMessageV3 implements ProductDetailOrBuilder

Detailed product information associated with a user event.

Protobuf type google.cloud.retail.v2.ProductDetail

Static Fields

PRODUCT_FIELD_NUMBER

public static final int PRODUCT_FIELD_NUMBER
Field Value
Type Description
int

QUANTITY_FIELD_NUMBER

public static final int QUANTITY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ProductDetail getDefaultInstance()
Returns
Type Description
ProductDetail

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ProductDetail.Builder newBuilder()
Returns
Type Description
ProductDetail.Builder

newBuilder(ProductDetail prototype)

public static ProductDetail.Builder newBuilder(ProductDetail prototype)
Parameter
Name Description
prototype ProductDetail
Returns
Type Description
ProductDetail.Builder

parseDelimitedFrom(InputStream input)

public static ProductDetail parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ProductDetail
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProductDetail parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProductDetail
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ProductDetail parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ProductDetail
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ProductDetail parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProductDetail
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ProductDetail parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ProductDetail
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ProductDetail parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProductDetail
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ProductDetail parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ProductDetail
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ProductDetail parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProductDetail
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ProductDetail parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ProductDetail
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProductDetail parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProductDetail
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ProductDetail parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ProductDetail
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ProductDetail parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProductDetail
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ProductDetail> parser()
Returns
Type Description
Parser<ProductDetail>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ProductDetail getDefaultInstanceForType()
Returns
Type Description
ProductDetail

getParserForType()

public Parser<ProductDetail> getParserForType()
Returns
Type Description
Parser<ProductDetail>
Overrides

getProduct()

public Product getProduct()

Required. Product information.

Required field(s):

  • Product.id

    Optional override field(s):

  • Product.price_info

    If any supported optional fields are provided, we will treat them as a full override when looking up product information from the catalog. Thus, it is important to ensure that the overriding fields are accurate and complete.

    All other product fields are ignored and instead populated via catalog lookup after event ingestion.

.google.cloud.retail.v2.Product product = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Product

The product.

getProductOrBuilder()

public ProductOrBuilder getProductOrBuilder()

Required. Product information.

Required field(s):

  • Product.id

    Optional override field(s):

  • Product.price_info

    If any supported optional fields are provided, we will treat them as a full override when looking up product information from the catalog. Thus, it is important to ensure that the overriding fields are accurate and complete.

    All other product fields are ignored and instead populated via catalog lookup after event ingestion.

.google.cloud.retail.v2.Product product = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProductOrBuilder

getQuantity()

public Int32Value getQuantity()

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 purchase-complete event. Required for add-to-cart and purchase-complete event types.

.google.protobuf.Int32Value quantity = 2;

Returns
Type Description
Int32Value

The quantity.

getQuantityOrBuilder()

public Int32ValueOrBuilder getQuantityOrBuilder()

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 purchase-complete event. Required for add-to-cart and purchase-complete event types.

.google.protobuf.Int32Value quantity = 2;

Returns
Type Description
Int32ValueOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasProduct()

public boolean hasProduct()

Required. Product information.

Required field(s):

  • Product.id

    Optional override field(s):

  • Product.price_info

    If any supported optional fields are provided, we will treat them as a full override when looking up product information from the catalog. Thus, it is important to ensure that the overriding fields are accurate and complete.

    All other product fields are ignored and instead populated via catalog lookup after event ingestion.

.google.cloud.retail.v2.Product product = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the product field is set.

hasQuantity()

public boolean hasQuantity()

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 purchase-complete event. Required for add-to-cart and purchase-complete event types.

.google.protobuf.Int32Value quantity = 2;

Returns
Type Description
boolean

Whether the quantity field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ProductDetail.Builder newBuilderForType()
Returns
Type Description
ProductDetail.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ProductDetail.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ProductDetail.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ProductDetail.Builder toBuilder()
Returns
Type Description
ProductDetail.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException