Class ProductLevelConfig

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
TypeDescription
int

MERCHANT_CENTER_PRODUCT_ID_FIELD_FIELD_NUMBER

public static final int MERCHANT_CENTER_PRODUCT_ID_FIELD_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ProductLevelConfig getDefaultInstance()
Returns
TypeDescription
ProductLevelConfig

getDescriptor()

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

newBuilder()

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

newBuilder(ProductLevelConfig prototype)

public static ProductLevelConfig.Builder newBuilder(ProductLevelConfig prototype)
Parameter
NameDescription
prototypeProductLevelConfig
Returns
TypeDescription
ProductLevelConfig.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ProductLevelConfig getDefaultInstanceForType()
Returns
TypeDescription
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: 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 Using product levels for more details.

string ingestion_product_type = 1;

Returns
TypeDescription
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: 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 Using product levels for more details.

string ingestion_product_type = 1;

Returns
TypeDescription
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 Using product levels for more details.

string merchant_center_product_id_field = 2;

Returns
TypeDescription
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 Using product levels for more details.

string merchant_center_product_id_field = 2;

Returns
TypeDescription
ByteString

The bytes for merchantCenterProductIdField.

getParserForType()

public Parser<ProductLevelConfig> getParserForType()
Returns
TypeDescription
Parser<ProductLevelConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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