Package com.google.cloud.vision.v1p4beta1

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.v1p4beta1.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 8 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

 The `image-uri`, `product-set-id`, `product-id`, and `product-category`
 columns are required. All other columns are optional.

 If the `ProductSet` or `Product` specified by the `product-set-id` and
 `product-id` values does not exist, then the system will create a new
 `ProductSet` or `Product` for the image. In this case, the
 `product-display-name` column refers to
 [display_name][google.cloud.vision.v1p4beta1.Product.display_name], the
 `product-category` column refers to
 [product_category][google.cloud.vision.v1p4beta1.Product.product_category],
 and the `labels` column refers to
 [product_labels][google.cloud.vision.v1p4beta1.Product.product_labels].

 The `image-id` column is optional but must be unique if provided. If it is
 empty, the system will automatically assign a unique id to the image.

 The `product-display-name` column is optional. If it is empty, the system
 sets the [display_name][google.cloud.vision.v1p4beta1.Product.display_name]
 field for the product to a space (" "). You can update the `display_name`
 later by using the API.

 If a `Product` with the specified `product-id` already exists, then the
 system ignores the `product-display-name`, `product-category`, and `labels`
 columns.

 The `labels` column (optional) is a line containing a list of
 comma-separated key-value pairs, in the following format:

     "key_1=value_1,key_2=value_2,...,key_n=value_n"

 The `bounding-poly` column (optional) identifies one region of
 interest from the image in the same manner as `CreateReferenceImage`. If
 you do not specify the `bounding-poly` column, then the system will try to
 detect regions of interest automatically.

 At most one `bounding-poly` column is allowed per line. If the image
 contains multiple regions of interest, add a line to the CSV file that
 includes the same product information, and the `bounding-poly` values for
 each region of interest.

 The `bounding-poly` column must contain an even number of comma-separated
 numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use
 non-negative integers for absolute bounding polygons, and float values
 in [0, 1] for normalized bounding polygons.

 The system will resize the image if the image resolution is too
 large to process (larger than 20MP).
        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 8 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

 The `image-uri`, `product-set-id`, `product-id`, and `product-category`
 columns are required. All other columns are optional.

 If the `ProductSet` or `Product` specified by the `product-set-id` and
 `product-id` values does not exist, then the system will create a new
 `ProductSet` or `Product` for the image. In this case, the
 `product-display-name` column refers to
 [display_name][google.cloud.vision.v1p4beta1.Product.display_name], the
 `product-category` column refers to
 [product_category][google.cloud.vision.v1p4beta1.Product.product_category],
 and the `labels` column refers to
 [product_labels][google.cloud.vision.v1p4beta1.Product.product_labels].

 The `image-id` column is optional but must be unique if provided. If it is
 empty, the system will automatically assign a unique id to the image.

 The `product-display-name` column is optional. If it is empty, the system
 sets the [display_name][google.cloud.vision.v1p4beta1.Product.display_name]
 field for the product to a space (" "). You can update the `display_name`
 later by using the API.

 If a `Product` with the specified `product-id` already exists, then the
 system ignores the `product-display-name`, `product-category`, and `labels`
 columns.

 The `labels` column (optional) is a line containing a list of
 comma-separated key-value pairs, in the following format:

     "key_1=value_1,key_2=value_2,...,key_n=value_n"

 The `bounding-poly` column (optional) identifies one region of
 interest from the image in the same manner as `CreateReferenceImage`. If
 you do not specify the `bounding-poly` column, then the system will try to
 detect regions of interest automatically.

 At most one `bounding-poly` column is allowed per line. If the image
 contains multiple regions of interest, add a line to the CSV file that
 includes the same product information, and the `bounding-poly` values for
 each region of interest.

 The `bounding-poly` column must contain an even number of comma-separated
 numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use
 non-negative integers for absolute bounding polygons, and float values
 in [0, 1] for normalized bounding polygons.

 The system will resize the image if the image resolution is too
 large to process (larger than 20MP).
        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