com.google.cloud.retail.v2

Class ProductLevelConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.retail.v2.ProductLevelConfig

All Implemented Interfaces:

ProductLevelConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class ProductLevelConfig
extends com.google.protobuf.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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProductLevelConfig.Builder Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	INGESTION_PRODUCT_TYPE_FIELD_NUMBER
static int	MERCHANT_CENTER_PRODUCT_ID_FIELD_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static ProductLevelConfig	getDefaultInstance()
ProductLevelConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getIngestionProductType() The type of [Product][google.cloud.retail.v2.Product]s allowed to be ingested into the catalog.
com.google.protobuf.ByteString	getIngestionProductTypeBytes() The type of [Product][google.cloud.retail.v2.Product]s allowed to be ingested into the catalog.
String	getMerchantCenterProductIdField() Which field of [Merchant Center Product](/bigquery-transfer/docs/merchant-center-products-schema) should be imported as [Product.id][google.cloud.retail.v2.Product.id].
com.google.protobuf.ByteString	getMerchantCenterProductIdFieldBytes() Which field of [Merchant Center Product](/bigquery-transfer/docs/merchant-center-products-schema) should be imported as [Product.id][google.cloud.retail.v2.Product.id].
com.google.protobuf.Parser<ProductLevelConfig>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ProductLevelConfig.Builder	newBuilder()
static ProductLevelConfig.Builder	newBuilder(ProductLevelConfig prototype)
ProductLevelConfig.Builder	newBuilderForType()
protected ProductLevelConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ProductLevelConfig	parseDelimitedFrom(InputStream input)
static ProductLevelConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProductLevelConfig	parseFrom(byte[] data)
static ProductLevelConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProductLevelConfig	parseFrom(ByteBuffer data)
static ProductLevelConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProductLevelConfig	parseFrom(com.google.protobuf.ByteString data)
static ProductLevelConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProductLevelConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static ProductLevelConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ProductLevelConfig	parseFrom(InputStream input)
static ProductLevelConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ProductLevelConfig>	parser()
ProductLevelConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

INGESTION_PRODUCT_TYPE_FIELD_NUMBER

public static final int INGESTION_PRODUCT_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

MERCHANT_CENTER_PRODUCT_ID_FIELD_FIELD_NUMBER

public static final int MERCHANT_CENTER_PRODUCT_ID_FIELD_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getIngestionProductType

public String getIngestionProductType()

 The type of [Product][google.cloud.retail.v2.Product]s allowed to be
 ingested into the catalog. Acceptable values are:

 * `primary` (default): You can ingest
 [Product][google.cloud.retail.v2.Product]s of all types. When
   ingesting a [Product][google.cloud.retail.v2.Product], its type will
   default to
   [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] if
   unset.
 * `variant` (incompatible with Retail Search): You can only
   ingest
   [Product.Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]
   [Product][google.cloud.retail.v2.Product]s. This means
   [Product.primary_product_id][google.cloud.retail.v2.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][google.cloud.retail.v2.ProductLevelConfig.merchant_center_product_id_field]
 is `itemGroupId`, an INVALID_ARGUMENT error is returned.

 See [Product
 levels](https://cloud.google.com/retail/docs/catalog#product-levels)
 for more details.
 

string ingestion_product_type = 1;

Specified by:

getIngestionProductType in interface ProductLevelConfigOrBuilder

Returns:

The ingestionProductType.

getIngestionProductTypeBytes

public com.google.protobuf.ByteString getIngestionProductTypeBytes()

 The type of [Product][google.cloud.retail.v2.Product]s allowed to be
 ingested into the catalog. Acceptable values are:

 * `primary` (default): You can ingest
 [Product][google.cloud.retail.v2.Product]s of all types. When
   ingesting a [Product][google.cloud.retail.v2.Product], its type will
   default to
   [Product.Type.PRIMARY][google.cloud.retail.v2.Product.Type.PRIMARY] if
   unset.
 * `variant` (incompatible with Retail Search): You can only
   ingest
   [Product.Type.VARIANT][google.cloud.retail.v2.Product.Type.VARIANT]
   [Product][google.cloud.retail.v2.Product]s. This means
   [Product.primary_product_id][google.cloud.retail.v2.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][google.cloud.retail.v2.ProductLevelConfig.merchant_center_product_id_field]
 is `itemGroupId`, an INVALID_ARGUMENT error is returned.

 See [Product
 levels](https://cloud.google.com/retail/docs/catalog#product-levels)
 for more details.
 

string ingestion_product_type = 1;

Specified by:

getIngestionProductTypeBytes in interface ProductLevelConfigOrBuilder

Returns:

The bytes for ingestionProductType.

getMerchantCenterProductIdField

public String getMerchantCenterProductIdField()

 Which field of [Merchant Center
 Product](/bigquery-transfer/docs/merchant-center-products-schema) should be
 imported as [Product.id][google.cloud.retail.v2.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][google.cloud.retail.v2.ProductLevelConfig.ingestion_product_type]
 is `variant`, an INVALID_ARGUMENT error is returned.

 See [Product
 levels](https://cloud.google.com/retail/docs/catalog#product-levels)
 for more details.
 

string merchant_center_product_id_field = 2;

Specified by:

getMerchantCenterProductIdField in interface ProductLevelConfigOrBuilder

Returns:

The merchantCenterProductIdField.

getMerchantCenterProductIdFieldBytes

public com.google.protobuf.ByteString getMerchantCenterProductIdFieldBytes()

 Which field of [Merchant Center
 Product](/bigquery-transfer/docs/merchant-center-products-schema) should be
 imported as [Product.id][google.cloud.retail.v2.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][google.cloud.retail.v2.ProductLevelConfig.ingestion_product_type]
 is `variant`, an INVALID_ARGUMENT error is returned.

 See [Product
 levels](https://cloud.google.com/retail/docs/catalog#product-levels)
 for more details.
 

string merchant_center_product_id_field = 2;

Specified by:

getMerchantCenterProductIdFieldBytes in interface ProductLevelConfigOrBuilder

Returns:

The bytes for merchantCenterProductIdField.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ProductLevelConfig parseFrom(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ProductLevelConfig parseFrom(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ProductLevelConfig parseFrom(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ProductLevelConfig parseFrom(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ProductLevelConfig parseFrom(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ProductLevelConfig parseFrom(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ProductLevelConfig parseFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

public static ProductLevelConfig parseFrom(InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static ProductLevelConfig parseDelimitedFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static ProductLevelConfig parseDelimitedFrom(InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

parseFrom

public static ProductLevelConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

public static ProductLevelConfig parseFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

newBuilderForType

public ProductLevelConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ProductLevelConfig.Builder newBuilder()

newBuilder

public static ProductLevelConfig.Builder newBuilder(ProductLevelConfig prototype)

toBuilder

public ProductLevelConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ProductLevelConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ProductLevelConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<ProductLevelConfig> parser()

getParserForType

public com.google.protobuf.Parser<ProductLevelConfig> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ProductLevelConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder