Class ProductLevelConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ProductLevelConfig.Builder>
com.google.cloud.retail.v2alpha.ProductLevelConfig.Builder
All Implemented Interfaces:
ProductLevelConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ProductLevelConfig

public static final class ProductLevelConfig.Builder extends com.google.protobuf.GeneratedMessage.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.v2alpha.ProductLevelConfig
  • Method Summary

    Modifier and Type
    Method
    Description
     
     
     
    The type of [Product][google.cloud.retail.v2alpha.Product]s allowed to be ingested into the catalog.
    Which field of [Merchant Center Product](/bigquery-transfer/docs/merchant-center-products-schema) should be imported as [Product.id][google.cloud.retail.v2alpha.Product.id].
     
    static final com.google.protobuf.Descriptors.Descriptor
     
    com.google.protobuf.Descriptors.Descriptor
     
    The type of [Product][google.cloud.retail.v2alpha.Product]s allowed to be ingested into the catalog.
    com.google.protobuf.ByteString
    The type of [Product][google.cloud.retail.v2alpha.Product]s allowed to be ingested into the catalog.
    Which field of [Merchant Center Product](/bigquery-transfer/docs/merchant-center-products-schema) should be imported as [Product.id][google.cloud.retail.v2alpha.Product.id].
    com.google.protobuf.ByteString
    Which field of [Merchant Center Product](/bigquery-transfer/docs/merchant-center-products-schema) should be imported as [Product.id][google.cloud.retail.v2alpha.Product.id].
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
     
    final boolean
     
     
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    mergeFrom(com.google.protobuf.Message other)
     
    The type of [Product][google.cloud.retail.v2alpha.Product]s allowed to be ingested into the catalog.
    setIngestionProductTypeBytes(com.google.protobuf.ByteString value)
    The type of [Product][google.cloud.retail.v2alpha.Product]s allowed to be ingested into the catalog.
    Which field of [Merchant Center Product](/bigquery-transfer/docs/merchant-center-products-schema) should be imported as [Product.id][google.cloud.retail.v2alpha.Product.id].
    setMerchantCenterProductIdFieldBytes(com.google.protobuf.ByteString value)
    Which field of [Merchant Center Product](/bigquery-transfer/docs/merchant-center-products-schema) should be imported as [Product.id][google.cloud.retail.v2alpha.Product.id].

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Method Details

    • getDescriptor

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

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ProductLevelConfig.Builder>
    • clear

      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ProductLevelConfig.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ProductLevelConfig.Builder>
    • getDefaultInstanceForType

      public ProductLevelConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      public ProductLevelConfig build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      public ProductLevelConfig buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • mergeFrom

      public ProductLevelConfig.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ProductLevelConfig.Builder>
    • mergeFrom

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ProductLevelConfig.Builder>
    • mergeFrom

      public ProductLevelConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ProductLevelConfig.Builder>
      Throws:
      IOException
    • getIngestionProductType

      public String getIngestionProductType()
       The type of [Product][google.cloud.retail.v2alpha.Product]s allowed to be
       ingested into the catalog. Acceptable values are:
      
       * `primary` (default): You can ingest
       [Product][google.cloud.retail.v2alpha.Product]s of all types. When
       ingesting a [Product][google.cloud.retail.v2alpha.Product], its type will
       default to
       [Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
       if unset.
       * `variant` (incompatible with Retail Search): You can only
       ingest
       [Product.Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
       [Product][google.cloud.retail.v2alpha.Product]s. This means
       [Product.primary_product_id][google.cloud.retail.v2alpha.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.v2alpha.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.v2alpha.Product]s allowed to be
       ingested into the catalog. Acceptable values are:
      
       * `primary` (default): You can ingest
       [Product][google.cloud.retail.v2alpha.Product]s of all types. When
       ingesting a [Product][google.cloud.retail.v2alpha.Product], its type will
       default to
       [Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
       if unset.
       * `variant` (incompatible with Retail Search): You can only
       ingest
       [Product.Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
       [Product][google.cloud.retail.v2alpha.Product]s. This means
       [Product.primary_product_id][google.cloud.retail.v2alpha.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.v2alpha.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.
    • setIngestionProductType

      public ProductLevelConfig.Builder setIngestionProductType(String value)
       The type of [Product][google.cloud.retail.v2alpha.Product]s allowed to be
       ingested into the catalog. Acceptable values are:
      
       * `primary` (default): You can ingest
       [Product][google.cloud.retail.v2alpha.Product]s of all types. When
       ingesting a [Product][google.cloud.retail.v2alpha.Product], its type will
       default to
       [Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
       if unset.
       * `variant` (incompatible with Retail Search): You can only
       ingest
       [Product.Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
       [Product][google.cloud.retail.v2alpha.Product]s. This means
       [Product.primary_product_id][google.cloud.retail.v2alpha.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.v2alpha.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;
      Parameters:
      value - The ingestionProductType to set.
      Returns:
      This builder for chaining.
    • clearIngestionProductType

      public ProductLevelConfig.Builder clearIngestionProductType()
       The type of [Product][google.cloud.retail.v2alpha.Product]s allowed to be
       ingested into the catalog. Acceptable values are:
      
       * `primary` (default): You can ingest
       [Product][google.cloud.retail.v2alpha.Product]s of all types. When
       ingesting a [Product][google.cloud.retail.v2alpha.Product], its type will
       default to
       [Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
       if unset.
       * `variant` (incompatible with Retail Search): You can only
       ingest
       [Product.Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
       [Product][google.cloud.retail.v2alpha.Product]s. This means
       [Product.primary_product_id][google.cloud.retail.v2alpha.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.v2alpha.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;
      Returns:
      This builder for chaining.
    • setIngestionProductTypeBytes

      public ProductLevelConfig.Builder setIngestionProductTypeBytes(com.google.protobuf.ByteString value)
       The type of [Product][google.cloud.retail.v2alpha.Product]s allowed to be
       ingested into the catalog. Acceptable values are:
      
       * `primary` (default): You can ingest
       [Product][google.cloud.retail.v2alpha.Product]s of all types. When
       ingesting a [Product][google.cloud.retail.v2alpha.Product], its type will
       default to
       [Product.Type.PRIMARY][google.cloud.retail.v2alpha.Product.Type.PRIMARY]
       if unset.
       * `variant` (incompatible with Retail Search): You can only
       ingest
       [Product.Type.VARIANT][google.cloud.retail.v2alpha.Product.Type.VARIANT]
       [Product][google.cloud.retail.v2alpha.Product]s. This means
       [Product.primary_product_id][google.cloud.retail.v2alpha.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.v2alpha.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;
      Parameters:
      value - The bytes for ingestionProductType to set.
      Returns:
      This builder for chaining.
    • 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.v2alpha.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.v2alpha.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.v2alpha.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.v2alpha.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.
    • setMerchantCenterProductIdField

      public ProductLevelConfig.Builder setMerchantCenterProductIdField(String value)
       Which field of [Merchant Center
       Product](/bigquery-transfer/docs/merchant-center-products-schema) should be
       imported as [Product.id][google.cloud.retail.v2alpha.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.v2alpha.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;
      Parameters:
      value - The merchantCenterProductIdField to set.
      Returns:
      This builder for chaining.
    • clearMerchantCenterProductIdField

      public ProductLevelConfig.Builder clearMerchantCenterProductIdField()
       Which field of [Merchant Center
       Product](/bigquery-transfer/docs/merchant-center-products-schema) should be
       imported as [Product.id][google.cloud.retail.v2alpha.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.v2alpha.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;
      Returns:
      This builder for chaining.
    • setMerchantCenterProductIdFieldBytes

      public ProductLevelConfig.Builder setMerchantCenterProductIdFieldBytes(com.google.protobuf.ByteString value)
       Which field of [Merchant Center
       Product](/bigquery-transfer/docs/merchant-center-products-schema) should be
       imported as [Product.id][google.cloud.retail.v2alpha.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.v2alpha.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;
      Parameters:
      value - The bytes for merchantCenterProductIdField to set.
      Returns:
      This builder for chaining.