Class ProductLevelConfig (2.56.0)

public final class ProductLevelConfig extends GeneratedMessageV3 implements ProductLevelConfigOrBuilder

Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made.

Protobuf type google.cloud.retail.v2.ProductLevelConfig

Static Fields

INGESTION_PRODUCT_TYPE_FIELD_NUMBER

public static final int INGESTION_PRODUCT_TYPE_FIELD_NUMBER
Field Value
Type Description
int

MERCHANT_CENTER_PRODUCT_ID_FIELD_FIELD_NUMBER

public static final int MERCHANT_CENTER_PRODUCT_ID_FIELD_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ProductLevelConfig getDefaultInstance()
Returns
Type Description
ProductLevelConfig

getDescriptor()

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

newBuilder()

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

newBuilder(ProductLevelConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ProductLevelConfig getDefaultInstanceForType()
Returns
Type Description
ProductLevelConfig

getIngestionProductType()

public String getIngestionProductType()

The type of Products allowed to be ingested into the catalog. Acceptable values are:

  • primary (default): You can ingest Products of all types. When ingesting a Product, its type will default to Product.Type.PRIMARY if unset.
  • variant (incompatible with Retail Search): You can only ingest Product.Type.VARIANT Products. This means Product.primary_product_id cannot be empty.

    If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.

    If this field is variant and merchant_center_product_id_field is itemGroupId, an INVALID_ARGUMENT error is returned.

    See Product levels for more details.

string ingestion_product_type = 1;

Returns
Type Description
String

The ingestionProductType.

getIngestionProductTypeBytes()

public ByteString getIngestionProductTypeBytes()

The type of Products allowed to be ingested into the catalog. Acceptable values are:

  • primary (default): You can ingest Products of all types. When ingesting a Product, its type will default to Product.Type.PRIMARY if unset.
  • variant (incompatible with Retail Search): You can only ingest Product.Type.VARIANT Products. This means Product.primary_product_id cannot be empty.

    If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.

    If this field is variant and merchant_center_product_id_field is itemGroupId, an INVALID_ARGUMENT error is returned.

    See Product levels for more details.

string ingestion_product_type = 1;

Returns
Type Description
ByteString

The bytes for ingestionProductType.

getMerchantCenterProductIdField()

public String getMerchantCenterProductIdField()

Which field of Merchant Center Product should be imported as Product.id. Acceptable values are:

  • offerId (default): Import offerId as the product ID.
  • itemGroupId: Import itemGroupId as the product ID. Notice that Retail API will choose one item from the ones with the same itemGroupId, and use it to represent the item group.

    If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.

    If this field is itemGroupId and ingestion_product_type is variant, an INVALID_ARGUMENT error is returned.

    See Product levels for more details.

string merchant_center_product_id_field = 2;

Returns
Type Description
String

The merchantCenterProductIdField.

getMerchantCenterProductIdFieldBytes()

public ByteString getMerchantCenterProductIdFieldBytes()

Which field of Merchant Center Product should be imported as Product.id. Acceptable values are:

  • offerId (default): Import offerId as the product ID.
  • itemGroupId: Import itemGroupId as the product ID. Notice that Retail API will choose one item from the ones with the same itemGroupId, and use it to represent the item group.

    If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.

    If this field is itemGroupId and ingestion_product_type is variant, an INVALID_ARGUMENT error is returned.

    See Product levels for more details.

string merchant_center_product_id_field = 2;

Returns
Type Description
ByteString

The bytes for merchantCenterProductIdField.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 ProductLevelConfig.Builder newBuilderForType()
Returns
Type Description
ProductLevelConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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