Package com.google.cloud.vision.v1p3beta1

Class ImportProductSetsGcsSource

  • All Implemented Interfaces:
    ImportProductSetsGcsSourceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ImportProductSetsGcsSource
extends com.google.protobuf.GeneratedMessageV3
implements ImportProductSetsGcsSourceOrBuilder
     The Google Cloud Storage location for a csv file which preserves a list of
 ImportProductSetRequests in each line.
    Protobuf type google.cloud.vision.v1p3beta1.ImportProductSetsGcsSource
    See Also:
    Serialized Form

    • Field Detail

      • CSV_FILE_URI_FIELD_NUMBER

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

      • getCsvFileUri

        public String getCsvFileUri()
         The Google Cloud Storage URI of the input csv file.

 The URI must start with `gs://`.

 The format of the input csv file should be one image per line.
 In each line, there are 6 columns.
 1. image_uri
 2, image_id
 3. product_set_id
 4. product_id
 5, product_category
 6, product_display_name
 7, labels
 8. bounding_poly

 Columns 1, 3, 4, and 5 are required, other columns are optional. A new
 ProductSet/Product with the same id will be created on the fly
 if the ProductSet/Product specified by product_set_id/product_id does not
 exist.

 The image_id field is optional but has to be unique if provided. If it is
 empty, we will automatically assign an unique id to the image.

 The product_display_name field is optional. If it is empty, a space (" ")
 is used as the place holder for the product display_name, which can
 be updated later through the realtime API.

 If the Product with product_id already exists, the fields
 product_display_name, product_category and labels are ignored.

 If a Product doesn't exist and needs to be created on the fly, the
 product_display_name field refers to
 [Product.display_name][google.cloud.vision.v1p3beta1.Product.display_name],
 the product_category field refers to
 [Product.product_category][google.cloud.vision.v1p3beta1.Product.product_category],
 and the labels field refers to [Product.labels][].

 Labels (optional) should be a line containing a list of comma-separated
 key-value pairs, with the format
     "key_1=value_1,key_2=value_2,...,key_n=value_n".

 The bounding_poly (optional) field is used to identify one region of
 interest from the image in the same manner as CreateReferenceImage. If no
 bounding_poly is specified, the system will try to detect regions of
 interest automatically.

 Note that the pipeline will resize the image if the image resolution is too
 large to process (above 20MP).

 Also note that at most one bounding_poly is allowed per line. If the image
 contains multiple regions of interest, the csv should contain one line per
 region of interest.

 The bounding_poly column should contain an even number of comma-separated
 numbers, with the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Nonnegative
 integers should be used for absolute bounding polygons, and float values
 in [0, 1] should be used for normalized bounding polygons.
        string csv_file_uri = 1;
        Specified by:
        getCsvFileUri in interface ImportProductSetsGcsSourceOrBuilder
        Returns:
        The csvFileUri.

      • getCsvFileUriBytes

        public com.google.protobuf.ByteString getCsvFileUriBytes()
         The Google Cloud Storage URI of the input csv file.

 The URI must start with `gs://`.

 The format of the input csv file should be one image per line.
 In each line, there are 6 columns.
 1. image_uri
 2, image_id
 3. product_set_id
 4. product_id
 5, product_category
 6, product_display_name
 7, labels
 8. bounding_poly

 Columns 1, 3, 4, and 5 are required, other columns are optional. A new
 ProductSet/Product with the same id will be created on the fly
 if the ProductSet/Product specified by product_set_id/product_id does not
 exist.

 The image_id field is optional but has to be unique if provided. If it is
 empty, we will automatically assign an unique id to the image.

 The product_display_name field is optional. If it is empty, a space (" ")
 is used as the place holder for the product display_name, which can
 be updated later through the realtime API.

 If the Product with product_id already exists, the fields
 product_display_name, product_category and labels are ignored.

 If a Product doesn't exist and needs to be created on the fly, the
 product_display_name field refers to
 [Product.display_name][google.cloud.vision.v1p3beta1.Product.display_name],
 the product_category field refers to
 [Product.product_category][google.cloud.vision.v1p3beta1.Product.product_category],
 and the labels field refers to [Product.labels][].

 Labels (optional) should be a line containing a list of comma-separated
 key-value pairs, with the format
     "key_1=value_1,key_2=value_2,...,key_n=value_n".

 The bounding_poly (optional) field is used to identify one region of
 interest from the image in the same manner as CreateReferenceImage. If no
 bounding_poly is specified, the system will try to detect regions of
 interest automatically.

 Note that the pipeline will resize the image if the image resolution is too
 large to process (above 20MP).

 Also note that at most one bounding_poly is allowed per line. If the image
 contains multiple regions of interest, the csv should contain one line per
 region of interest.

 The bounding_poly column should contain an even number of comma-separated
 numbers, with the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Nonnegative
 integers should be used for absolute bounding polygons, and float values
 in [0, 1] should be used for normalized bounding polygons.
        string csv_file_uri = 1;
        Specified by:
        getCsvFileUriBytes in interface ImportProductSetsGcsSourceOrBuilder
        Returns:
        The bytes for csvFileUri.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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