Package com.google.cloud.vision.v1

Class ProductSearchParams

  • All Implemented Interfaces:
    ProductSearchParamsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ProductSearchParams
extends com.google.protobuf.GeneratedMessageV3
implements ProductSearchParamsOrBuilder
     Parameters for a product search request.
    Protobuf type google.cloud.vision.v1.ProductSearchParams
    See Also:
    Serialized Form

    • Field Detail

      • BOUNDING_POLY_FIELD_NUMBER

        public static final int BOUNDING_POLY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PRODUCT_SET_FIELD_NUMBER

        public static final int PRODUCT_SET_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PRODUCT_CATEGORIES_FIELD_NUMBER

        public static final int PRODUCT_CATEGORIES_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

      • hasBoundingPoly

        public 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;
        Specified by:
        hasBoundingPoly in interface ProductSearchParamsOrBuilder
        Returns:
        Whether the boundingPoly field is set.

      • getBoundingPoly

        public 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;
        Specified by:
        getBoundingPoly in interface ProductSearchParamsOrBuilder
        Returns:
        The boundingPoly.

      • getProductSet

        public 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) = { ... }
        Specified by:
        getProductSet in interface ProductSearchParamsOrBuilder
        Returns:
        The productSet.

      • getProductSetBytes

        public 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) = { ... }
        Specified by:
        getProductSetBytes in interface ProductSearchParamsOrBuilder
        Returns:
        The bytes for productSet.

      • getProductCategoriesList

        public com.google.protobuf.ProtocolStringList 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;
        Specified by:
        getProductCategoriesList in interface ProductSearchParamsOrBuilder
        Returns:
        A list containing the productCategories.

      • getProductCategoriesCount

        public 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;
        Specified by:
        getProductCategoriesCount in interface ProductSearchParamsOrBuilder
        Returns:
        The count of productCategories.

      • getProductCategories

        public 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;
        Specified by:
        getProductCategories in interface ProductSearchParamsOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The productCategories at the given index.

      • getProductCategoriesBytes

        public 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;
        Specified by:
        getProductCategoriesBytes in interface ProductSearchParamsOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the productCategories at the given index.

      • getFilter

        public 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;
        Specified by:
        getFilter in interface ProductSearchParamsOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public 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;
        Specified by:
        getFilterBytes in interface ProductSearchParamsOrBuilder
        Returns:
        The bytes for filter.

      • 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 ProductSearchParams parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ProductSearchParams parseFrom​(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ProductSearchParams parseFrom​(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ProductSearchParams parseFrom​(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ProductSearchParams parseFrom​(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ProductSearchParams parseFrom​(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ProductSearchParams parseFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
        Throws:
        IOException

      • newBuilderForType

        public ProductSearchParams.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ProductSearchParams.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ProductSearchParams.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ProductSearchParams> 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 ProductSearchParams getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder