Package com.google.cloud.vision.v1

Class Product.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Product.Builder>
com.google.cloud.vision.v1.Product.Builder
All Implemented Interfaces:
ProductOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Product
public static final class Product.Builder extends com.google.protobuf.GeneratedMessage.Builder<Product.Builder> implements ProductOrBuilder
 A Product contains ReferenceImages.
Protobuf type google.cloud.vision.v1.Product

  • 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<Product.Builder>

    • clear

      public Product.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<Product.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<Product.Builder>

    • getDefaultInstanceForType

      public Product getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

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

    • buildPartial

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

    • mergeFrom

      public Product.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<Product.Builder>

    • mergeFrom

      public Product.Builder mergeFrom(Product other)

    • isInitialized

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

    • mergeFrom

      public Product.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<Product.Builder>
      Throws:
      IOException

    • getName

      public String getName()
       The resource name of the product.

 Format is:
 `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.

 This field is ignored when creating a product.
      string name = 1;
      Specified by:
      getName in interface ProductOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The resource name of the product.

 Format is:
 `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.

 This field is ignored when creating a product.
      string name = 1;
      Specified by:
      getNameBytes in interface ProductOrBuilder
      Returns:
      The bytes for name.

    • setName

      public Product.Builder setName(String value)
       The resource name of the product.

 Format is:
 `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.

 This field is ignored when creating a product.
      string name = 1;
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public Product.Builder clearName()
       The resource name of the product.

 Format is:
 `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.

 This field is ignored when creating a product.
      string name = 1;
      Returns:
      This builder for chaining.

    • setNameBytes

      public Product.Builder setNameBytes(com.google.protobuf.ByteString value)
       The resource name of the product.

 Format is:
 `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.

 This field is ignored when creating a product.
      string name = 1;
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getDisplayName

      public String getDisplayName()
       The user-provided name for this Product. Must not be empty. Must be at most
 4096 characters long.
      string display_name = 2;
      Specified by:
      getDisplayName in interface ProductOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       The user-provided name for this Product. Must not be empty. Must be at most
 4096 characters long.
      string display_name = 2;
      Specified by:
      getDisplayNameBytes in interface ProductOrBuilder
      Returns:
      The bytes for displayName.

    • setDisplayName

      public Product.Builder setDisplayName(String value)
       The user-provided name for this Product. Must not be empty. Must be at most
 4096 characters long.
      string display_name = 2;
      Parameters:
      value - The displayName to set.
      Returns:
      This builder for chaining.

    • clearDisplayName

      public Product.Builder clearDisplayName()
       The user-provided name for this Product. Must not be empty. Must be at most
 4096 characters long.
      string display_name = 2;
      Returns:
      This builder for chaining.

    • setDisplayNameBytes

      public Product.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
       The user-provided name for this Product. Must not be empty. Must be at most
 4096 characters long.
      string display_name = 2;
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.

    • getDescription

      public String getDescription()
       User-provided metadata to be stored with this product. Must be at most 4096
 characters long.
      string description = 3;
      Specified by:
      getDescription in interface ProductOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       User-provided metadata to be stored with this product. Must be at most 4096
 characters long.
      string description = 3;
      Specified by:
      getDescriptionBytes in interface ProductOrBuilder
      Returns:
      The bytes for description.

    • setDescription

      public Product.Builder setDescription(String value)
       User-provided metadata to be stored with this product. Must be at most 4096
 characters long.
      string description = 3;
      Parameters:
      value - The description to set.
      Returns:
      This builder for chaining.

    • clearDescription

      public Product.Builder clearDescription()
       User-provided metadata to be stored with this product. Must be at most 4096
 characters long.
      string description = 3;
      Returns:
      This builder for chaining.

    • setDescriptionBytes

      public Product.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
       User-provided metadata to be stored with this product. Must be at most 4096
 characters long.
      string description = 3;
      Parameters:
      value - The bytes for description to set.
      Returns:
      This builder for chaining.

    • getProductCategory

      public String getProductCategory()
       Immutable. The category for the product identified by the reference image.
 This should be one of "homegoods-v2", "apparel-v2", "toys-v2",
 "packagedgoods-v1" or "general-v1". The legacy categories "homegoods",
 "apparel", and "toys" are still supported, but these should not be used for
 new products.
      string product_category = 4 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getProductCategory in interface ProductOrBuilder
      Returns:
      The productCategory.

    • getProductCategoryBytes

      public com.google.protobuf.ByteString getProductCategoryBytes()
       Immutable. The category for the product identified by the reference image.
 This should be one of "homegoods-v2", "apparel-v2", "toys-v2",
 "packagedgoods-v1" or "general-v1". The legacy categories "homegoods",
 "apparel", and "toys" are still supported, but these should not be used for
 new products.
      string product_category = 4 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getProductCategoryBytes in interface ProductOrBuilder
      Returns:
      The bytes for productCategory.

    • setProductCategory

      public Product.Builder setProductCategory(String value)
       Immutable. The category for the product identified by the reference image.
 This should be one of "homegoods-v2", "apparel-v2", "toys-v2",
 "packagedgoods-v1" or "general-v1". The legacy categories "homegoods",
 "apparel", and "toys" are still supported, but these should not be used for
 new products.
      string product_category = 4 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The productCategory to set.
      Returns:
      This builder for chaining.

    • clearProductCategory

      public Product.Builder clearProductCategory()
       Immutable. The category for the product identified by the reference image.
 This should be one of "homegoods-v2", "apparel-v2", "toys-v2",
 "packagedgoods-v1" or "general-v1". The legacy categories "homegoods",
 "apparel", and "toys" are still supported, but these should not be used for
 new products.
      string product_category = 4 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      This builder for chaining.

    • setProductCategoryBytes

      public Product.Builder setProductCategoryBytes(com.google.protobuf.ByteString value)
       Immutable. The category for the product identified by the reference image.
 This should be one of "homegoods-v2", "apparel-v2", "toys-v2",
 "packagedgoods-v1" or "general-v1". The legacy categories "homegoods",
 "apparel", and "toys" are still supported, but these should not be used for
 new products.
      string product_category = 4 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The bytes for productCategory to set.
      Returns:
      This builder for chaining.

    • getProductLabelsList

      public List<Product.KeyValue> getProductLabelsList()
       Key-value pairs that can be attached to a product. At query time,
 constraints can be specified based on the product_labels.

 Note that integer values can be provided as strings, e.g. "1199". Only
 strings with integer values can match a range-based restriction which is
 to be supported soon.

 Multiple values can be assigned to the same key. One product may have up to
 500 product_labels.

 Notice that the total number of distinct product_labels over all products
 in one ProductSet cannot exceed 1M, otherwise the product search pipeline
 will refuse to work for that ProductSet.
      repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;
      Specified by:
      getProductLabelsList in interface ProductOrBuilder

    • getProductLabelsCount

      public int getProductLabelsCount()
       Key-value pairs that can be attached to a product. At query time,
 constraints can be specified based on the product_labels.

 Note that integer values can be provided as strings, e.g. "1199". Only
 strings with integer values can match a range-based restriction which is
 to be supported soon.

 Multiple values can be assigned to the same key. One product may have up to
 500 product_labels.

 Notice that the total number of distinct product_labels over all products
 in one ProductSet cannot exceed 1M, otherwise the product search pipeline
 will refuse to work for that ProductSet.
      repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;
      Specified by:
      getProductLabelsCount in interface ProductOrBuilder

    • getProductLabels

      public Product.KeyValue getProductLabels(int index)
       Key-value pairs that can be attached to a product. At query time,
 constraints can be specified based on the product_labels.

 Note that integer values can be provided as strings, e.g. "1199". Only
 strings with integer values can match a range-based restriction which is
 to be supported soon.

 Multiple values can be assigned to the same key. One product may have up to
 500 product_labels.

 Notice that the total number of distinct product_labels over all products
 in one ProductSet cannot exceed 1M, otherwise the product search pipeline
 will refuse to work for that ProductSet.
      repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;
      Specified by:
      getProductLabels in interface ProductOrBuilder

    • setProductLabels

      public Product.Builder setProductLabels(int index, Product.KeyValue value)
       Key-value pairs that can be attached to a product. At query time,
 constraints can be specified based on the product_labels.

 Note that integer values can be provided as strings, e.g. "1199". Only
 strings with integer values can match a range-based restriction which is
 to be supported soon.

 Multiple values can be assigned to the same key. One product may have up to
 500 product_labels.

 Notice that the total number of distinct product_labels over all products
 in one ProductSet cannot exceed 1M, otherwise the product search pipeline
 will refuse to work for that ProductSet.
      repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;

    • setProductLabels

      public Product.Builder setProductLabels(int index, Product.KeyValue.Builder builderForValue)
       Key-value pairs that can be attached to a product. At query time,
 constraints can be specified based on the product_labels.

 Note that integer values can be provided as strings, e.g. "1199". Only
 strings with integer values can match a range-based restriction which is
 to be supported soon.

 Multiple values can be assigned to the same key. One product may have up to
 500 product_labels.

 Notice that the total number of distinct product_labels over all products
 in one ProductSet cannot exceed 1M, otherwise the product search pipeline
 will refuse to work for that ProductSet.
      repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;

    • addProductLabels

      public Product.Builder addProductLabels(Product.KeyValue value)
       Key-value pairs that can be attached to a product. At query time,
 constraints can be specified based on the product_labels.

 Note that integer values can be provided as strings, e.g. "1199". Only
 strings with integer values can match a range-based restriction which is
 to be supported soon.

 Multiple values can be assigned to the same key. One product may have up to
 500 product_labels.

 Notice that the total number of distinct product_labels over all products
 in one ProductSet cannot exceed 1M, otherwise the product search pipeline
 will refuse to work for that ProductSet.
      repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;

    • addProductLabels

      public Product.Builder addProductLabels(int index, Product.KeyValue value)
       Key-value pairs that can be attached to a product. At query time,
 constraints can be specified based on the product_labels.

 Note that integer values can be provided as strings, e.g. "1199". Only
 strings with integer values can match a range-based restriction which is
 to be supported soon.

 Multiple values can be assigned to the same key. One product may have up to
 500 product_labels.

 Notice that the total number of distinct product_labels over all products
 in one ProductSet cannot exceed 1M, otherwise the product search pipeline
 will refuse to work for that ProductSet.
      repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;

    • addProductLabels

      public Product.Builder addProductLabels(Product.KeyValue.Builder builderForValue)
       Key-value pairs that can be attached to a product. At query time,
 constraints can be specified based on the product_labels.

 Note that integer values can be provided as strings, e.g. "1199". Only
 strings with integer values can match a range-based restriction which is
 to be supported soon.

 Multiple values can be assigned to the same key. One product may have up to
 500 product_labels.

 Notice that the total number of distinct product_labels over all products
 in one ProductSet cannot exceed 1M, otherwise the product search pipeline
 will refuse to work for that ProductSet.
      repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;

    • addProductLabels

      public Product.Builder addProductLabels(int index, Product.KeyValue.Builder builderForValue)
       Key-value pairs that can be attached to a product. At query time,
 constraints can be specified based on the product_labels.

 Note that integer values can be provided as strings, e.g. "1199". Only
 strings with integer values can match a range-based restriction which is
 to be supported soon.

 Multiple values can be assigned to the same key. One product may have up to
 500 product_labels.

 Notice that the total number of distinct product_labels over all products
 in one ProductSet cannot exceed 1M, otherwise the product search pipeline
 will refuse to work for that ProductSet.
      repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;

    • addAllProductLabels

      public Product.Builder addAllProductLabels(Iterable<? extends Product.KeyValue> values)
       Key-value pairs that can be attached to a product. At query time,
 constraints can be specified based on the product_labels.

 Note that integer values can be provided as strings, e.g. "1199". Only
 strings with integer values can match a range-based restriction which is
 to be supported soon.

 Multiple values can be assigned to the same key. One product may have up to
 500 product_labels.

 Notice that the total number of distinct product_labels over all products
 in one ProductSet cannot exceed 1M, otherwise the product search pipeline
 will refuse to work for that ProductSet.
      repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;

    • clearProductLabels

      public Product.Builder clearProductLabels()
       Key-value pairs that can be attached to a product. At query time,
 constraints can be specified based on the product_labels.

 Note that integer values can be provided as strings, e.g. "1199". Only
 strings with integer values can match a range-based restriction which is
 to be supported soon.

 Multiple values can be assigned to the same key. One product may have up to
 500 product_labels.

 Notice that the total number of distinct product_labels over all products
 in one ProductSet cannot exceed 1M, otherwise the product search pipeline
 will refuse to work for that ProductSet.
      repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;

    • removeProductLabels

      public Product.Builder removeProductLabels(int index)
       Key-value pairs that can be attached to a product. At query time,
 constraints can be specified based on the product_labels.

 Note that integer values can be provided as strings, e.g. "1199". Only
 strings with integer values can match a range-based restriction which is
 to be supported soon.

 Multiple values can be assigned to the same key. One product may have up to
 500 product_labels.

 Notice that the total number of distinct product_labels over all products
 in one ProductSet cannot exceed 1M, otherwise the product search pipeline
 will refuse to work for that ProductSet.
      repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;

    • getProductLabelsBuilder

      public Product.KeyValue.Builder getProductLabelsBuilder(int index)
       Key-value pairs that can be attached to a product. At query time,
 constraints can be specified based on the product_labels.

 Note that integer values can be provided as strings, e.g. "1199". Only
 strings with integer values can match a range-based restriction which is
 to be supported soon.

 Multiple values can be assigned to the same key. One product may have up to
 500 product_labels.

 Notice that the total number of distinct product_labels over all products
 in one ProductSet cannot exceed 1M, otherwise the product search pipeline
 will refuse to work for that ProductSet.
      repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;

    • getProductLabelsOrBuilder

      public Product.KeyValueOrBuilder getProductLabelsOrBuilder(int index)
       Key-value pairs that can be attached to a product. At query time,
 constraints can be specified based on the product_labels.

 Note that integer values can be provided as strings, e.g. "1199". Only
 strings with integer values can match a range-based restriction which is
 to be supported soon.

 Multiple values can be assigned to the same key. One product may have up to
 500 product_labels.

 Notice that the total number of distinct product_labels over all products
 in one ProductSet cannot exceed 1M, otherwise the product search pipeline
 will refuse to work for that ProductSet.
      repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;
      Specified by:
      getProductLabelsOrBuilder in interface ProductOrBuilder

    • getProductLabelsOrBuilderList

      public List<? extends Product.KeyValueOrBuilder> getProductLabelsOrBuilderList()
       Key-value pairs that can be attached to a product. At query time,
 constraints can be specified based on the product_labels.

 Note that integer values can be provided as strings, e.g. "1199". Only
 strings with integer values can match a range-based restriction which is
 to be supported soon.

 Multiple values can be assigned to the same key. One product may have up to
 500 product_labels.

 Notice that the total number of distinct product_labels over all products
 in one ProductSet cannot exceed 1M, otherwise the product search pipeline
 will refuse to work for that ProductSet.
      repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;
      Specified by:
      getProductLabelsOrBuilderList in interface ProductOrBuilder

    • addProductLabelsBuilder

      public Product.KeyValue.Builder addProductLabelsBuilder()
       Key-value pairs that can be attached to a product. At query time,
 constraints can be specified based on the product_labels.

 Note that integer values can be provided as strings, e.g. "1199". Only
 strings with integer values can match a range-based restriction which is
 to be supported soon.

 Multiple values can be assigned to the same key. One product may have up to
 500 product_labels.

 Notice that the total number of distinct product_labels over all products
 in one ProductSet cannot exceed 1M, otherwise the product search pipeline
 will refuse to work for that ProductSet.
      repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;

    • addProductLabelsBuilder

      public Product.KeyValue.Builder addProductLabelsBuilder(int index)
       Key-value pairs that can be attached to a product. At query time,
 constraints can be specified based on the product_labels.

 Note that integer values can be provided as strings, e.g. "1199". Only
 strings with integer values can match a range-based restriction which is
 to be supported soon.

 Multiple values can be assigned to the same key. One product may have up to
 500 product_labels.

 Notice that the total number of distinct product_labels over all products
 in one ProductSet cannot exceed 1M, otherwise the product search pipeline
 will refuse to work for that ProductSet.
      repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;

    • getProductLabelsBuilderList

      public List<Product.KeyValue.Builder> getProductLabelsBuilderList()
       Key-value pairs that can be attached to a product. At query time,
 constraints can be specified based on the product_labels.

 Note that integer values can be provided as strings, e.g. "1199". Only
 strings with integer values can match a range-based restriction which is
 to be supported soon.

 Multiple values can be assigned to the same key. One product may have up to
 500 product_labels.

 Notice that the total number of distinct product_labels over all products
 in one ProductSet cannot exceed 1M, otherwise the product search pipeline
 will refuse to work for that ProductSet.
      repeated .google.cloud.vision.v1.Product.KeyValue product_labels = 5;