Class ProductLevelConfig.Builder (2.13.0)

public static final class ProductLevelConfig.Builder extends GeneratedMessageV3.Builder<ProductLevelConfig.Builder> 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.v2beta.ProductLevelConfig

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ProductLevelConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ProductLevelConfig.Builder
Overrides

build()

public ProductLevelConfig build()
Returns
TypeDescription
ProductLevelConfig

buildPartial()

public ProductLevelConfig buildPartial()
Returns
TypeDescription
ProductLevelConfig

clear()

public ProductLevelConfig.Builder clear()
Returns
TypeDescription
ProductLevelConfig.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ProductLevelConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ProductLevelConfig.Builder
Overrides

clearIngestionProductType()

public ProductLevelConfig.Builder clearIngestionProductType()

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
TypeDescription
ProductLevelConfig.Builder

This builder for chaining.

clearMerchantCenterProductIdField()

public ProductLevelConfig.Builder clearMerchantCenterProductIdField()

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
TypeDescription
ProductLevelConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ProductLevelConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ProductLevelConfig.Builder
Overrides

clone()

public ProductLevelConfig.Builder clone()
Returns
TypeDescription
ProductLevelConfig.Builder
Overrides

getDefaultInstanceForType()

public ProductLevelConfig getDefaultInstanceForType()
Returns
TypeDescription
ProductLevelConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
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 (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
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 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 Product levels for more details.

string merchant_center_product_id_field = 2;

Returns
TypeDescription
ByteString

The bytes for merchantCenterProductIdField.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ProductLevelConfig other)

public ProductLevelConfig.Builder mergeFrom(ProductLevelConfig other)
Parameter
NameDescription
otherProductLevelConfig
Returns
TypeDescription
ProductLevelConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ProductLevelConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProductLevelConfig.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ProductLevelConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ProductLevelConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ProductLevelConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ProductLevelConfig.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ProductLevelConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ProductLevelConfig.Builder
Overrides

setIngestionProductType(String value)

public ProductLevelConfig.Builder setIngestionProductType(String value)

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;

Parameter
NameDescription
valueString

The ingestionProductType to set.

Returns
TypeDescription
ProductLevelConfig.Builder

This builder for chaining.

setIngestionProductTypeBytes(ByteString value)

public ProductLevelConfig.Builder setIngestionProductTypeBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for ingestionProductType to set.

Returns
TypeDescription
ProductLevelConfig.Builder

This builder for chaining.

setMerchantCenterProductIdField(String value)

public ProductLevelConfig.Builder setMerchantCenterProductIdField(String value)

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;

Parameter
NameDescription
valueString

The merchantCenterProductIdField to set.

Returns
TypeDescription
ProductLevelConfig.Builder

This builder for chaining.

setMerchantCenterProductIdFieldBytes(ByteString value)

public ProductLevelConfig.Builder setMerchantCenterProductIdFieldBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for merchantCenterProductIdField to set.

Returns
TypeDescription
ProductLevelConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ProductLevelConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ProductLevelConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ProductLevelConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ProductLevelConfig.Builder
Overrides