Class ProductDetail (2.39.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
TypeDescription
int

QUANTITY_FIELD_NUMBER

public static final int QUANTITY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ProductDetail getDefaultInstance()
Returns
TypeDescription
ProductDetail

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ProductDetail.Builder newBuilder()
Returns
TypeDescription
ProductDetail.Builder

newBuilder(ProductDetail prototype)

public static ProductDetail.Builder newBuilder(ProductDetail prototype)
Parameter
NameDescription
prototypeProductDetail
Returns
TypeDescription
ProductDetail.Builder

parseDelimitedFrom(InputStream input)

public static ProductDetail parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ProductDetail
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProductDetail parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProductDetail
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ProductDetail parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ProductDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ProductDetail parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProductDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ProductDetail parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ProductDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ProductDetail parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProductDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ProductDetail parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ProductDetail
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ProductDetail parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProductDetail
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ProductDetail parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ProductDetail
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProductDetail parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProductDetail
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ProductDetail parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ProductDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ProductDetail parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProductDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ProductDetail> parser()
Returns
TypeDescription
Parser<ProductDetail>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ProductDetail getDefaultInstanceForType()
Returns
TypeDescription
ProductDetail

getParserForType()

public Parser<ProductDetail> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
Int32ValueOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the quantity field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ProductDetail.Builder newBuilderForType()
Returns
TypeDescription
ProductDetail.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ProductDetail.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ProductDetail.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ProductDetail.Builder toBuilder()
Returns
TypeDescription
ProductDetail.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException