Package com.google.cloud.vision.v1

Interface ProductSearchParamsOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    BoundingPoly
    getBoundingPoly()
    The bounding polygon around the area of interest in the image.
    BoundingPolyOrBuilder
    getBoundingPolyOrBuilder()
    The bounding polygon around the area of interest in the image.
    String
    getFilter()
    The filtering expression.
    com.google.protobuf.ByteString
    getFilterBytes()
    The filtering expression.
    String
    getProductCategories(int index)
    The list of product categories to search in.
    com.google.protobuf.ByteString
    getProductCategoriesBytes(int index)
    The list of product categories to search in.
    int
    getProductCategoriesCount()
    The list of product categories to search in.
    List<String>
    getProductCategoriesList()
    The list of product categories to search in.
    String
    getProductSet()
    The resource name of a [ProductSet][google.cloud.vision.v1.ProductSet] to be searched for similar images.
    com.google.protobuf.ByteString
    getProductSetBytes()
    The resource name of a [ProductSet][google.cloud.vision.v1.ProductSet] to be searched for similar images.
    boolean
    hasBoundingPoly()
    The bounding polygon around the area of interest in the image.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • hasBoundingPoly

      boolean hasBoundingPoly()
       The bounding polygon around the area of interest in the image.
 If it is not specified, system discretion will be applied.
      .google.cloud.vision.v1.BoundingPoly bounding_poly = 9;
      Returns:
      Whether the boundingPoly field is set.

    • getBoundingPoly

      BoundingPoly getBoundingPoly()
       The bounding polygon around the area of interest in the image.
 If it is not specified, system discretion will be applied.
      .google.cloud.vision.v1.BoundingPoly bounding_poly = 9;
      Returns:
      The boundingPoly.

    • getBoundingPolyOrBuilder

      BoundingPolyOrBuilder getBoundingPolyOrBuilder()
       The bounding polygon around the area of interest in the image.
 If it is not specified, system discretion will be applied.
      .google.cloud.vision.v1.BoundingPoly bounding_poly = 9;

    • getProductSet

      String getProductSet()
       The resource name of a [ProductSet][google.cloud.vision.v1.ProductSet] to
 be searched for similar images.

 Format is:
 `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.
      string product_set = 6 [(.google.api.resource_reference) = { ... }
      Returns:
      The productSet.

    • getProductSetBytes

      com.google.protobuf.ByteString getProductSetBytes()
       The resource name of a [ProductSet][google.cloud.vision.v1.ProductSet] to
 be searched for similar images.

 Format is:
 `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`.
      string product_set = 6 [(.google.api.resource_reference) = { ... }
      Returns:
      The bytes for productSet.

    • getProductCategoriesList

      List<String> getProductCategoriesList()
       The list of product categories to search in. Currently, we only consider
 the first category, and either "homegoods-v2", "apparel-v2", "toys-v2",
 "packagedgoods-v1", or "general-v1" should be specified. The legacy
 categories "homegoods", "apparel", and "toys" are still supported but will
 be deprecated. For new products, please use "homegoods-v2", "apparel-v2",
 or "toys-v2" for better product search accuracy. It is recommended to
 migrate existing products to these categories as well.
      repeated string product_categories = 7;
      Returns:
      A list containing the productCategories.

    • getProductCategoriesCount

      int getProductCategoriesCount()
       The list of product categories to search in. Currently, we only consider
 the first category, and either "homegoods-v2", "apparel-v2", "toys-v2",
 "packagedgoods-v1", or "general-v1" should be specified. The legacy
 categories "homegoods", "apparel", and "toys" are still supported but will
 be deprecated. For new products, please use "homegoods-v2", "apparel-v2",
 or "toys-v2" for better product search accuracy. It is recommended to
 migrate existing products to these categories as well.
      repeated string product_categories = 7;
      Returns:
      The count of productCategories.

    • getProductCategories

      String getProductCategories(int index)
       The list of product categories to search in. Currently, we only consider
 the first category, and either "homegoods-v2", "apparel-v2", "toys-v2",
 "packagedgoods-v1", or "general-v1" should be specified. The legacy
 categories "homegoods", "apparel", and "toys" are still supported but will
 be deprecated. For new products, please use "homegoods-v2", "apparel-v2",
 or "toys-v2" for better product search accuracy. It is recommended to
 migrate existing products to these categories as well.
      repeated string product_categories = 7;
      Parameters:
      index - The index of the element to return.
      Returns:
      The productCategories at the given index.

    • getProductCategoriesBytes

      com.google.protobuf.ByteString getProductCategoriesBytes(int index)
       The list of product categories to search in. Currently, we only consider
 the first category, and either "homegoods-v2", "apparel-v2", "toys-v2",
 "packagedgoods-v1", or "general-v1" should be specified. The legacy
 categories "homegoods", "apparel", and "toys" are still supported but will
 be deprecated. For new products, please use "homegoods-v2", "apparel-v2",
 or "toys-v2" for better product search accuracy. It is recommended to
 migrate existing products to these categories as well.
      repeated string product_categories = 7;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the productCategories at the given index.

    • getFilter

      String getFilter()
       The filtering expression. This can be used to restrict search results based
 on Product labels. We currently support an AND of OR of key-value
 expressions, where each expression within an OR must have the same key. An
 '=' should be used to connect the key and value.

 For example, "(color = red OR color = blue) AND brand = Google" is
 acceptable, but "(color = red OR brand = Google)" is not acceptable.
 "color: red" is not acceptable because it uses a ':' instead of an '='.
      string filter = 8;
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       The filtering expression. This can be used to restrict search results based
 on Product labels. We currently support an AND of OR of key-value
 expressions, where each expression within an OR must have the same key. An
 '=' should be used to connect the key and value.

 For example, "(color = red OR color = blue) AND brand = Google" is
 acceptable, but "(color = red OR brand = Google)" is not acceptable.
 "color: red" is not acceptable because it uses a ':' instead of an '='.
      string filter = 8;
      Returns:
      The bytes for filter.