Package com.google.cloud.vision.v1

Interface ProductOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Product, Product.Builder
@Generated public interface ProductOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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;
      Returns:
      The name.

    • getNameBytes

      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;
      Returns:
      The bytes for name.

    • getDisplayName

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

    • getDisplayNameBytes

      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;
      Returns:
      The bytes for displayName.

    • getDescription

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

    • getDescriptionBytes

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

    • getProductCategory

      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];
      Returns:
      The productCategory.

    • getProductCategoryBytes

      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];
      Returns:
      The bytes for productCategory.

    • getProductLabelsList

      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;

    • getProductLabels

      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;

    • getProductLabelsCount

      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;

    • getProductLabelsOrBuilderList

      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;

    • getProductLabelsOrBuilder

      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;