Class ImportProductSetsGcsSource.Builder (3.50.0)

public static final class ImportProductSetsGcsSource.Builder extends GeneratedMessageV3.Builder<ImportProductSetsGcsSource.Builder> 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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ImportProductSetsGcsSource.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ImportProductSetsGcsSource.Builder
Overrides

build()

public ImportProductSetsGcsSource build()
Returns
Type Description
ImportProductSetsGcsSource

buildPartial()

public ImportProductSetsGcsSource buildPartial()
Returns
Type Description
ImportProductSetsGcsSource

clear()

public ImportProductSetsGcsSource.Builder clear()
Returns
Type Description
ImportProductSetsGcsSource.Builder
Overrides

clearCsvFileUri()

public ImportProductSetsGcsSource.Builder clearCsvFileUri()

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, the product-category column refers to product_category, and the labels column refers to 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 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;

Returns
Type Description
ImportProductSetsGcsSource.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ImportProductSetsGcsSource.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ImportProductSetsGcsSource.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ImportProductSetsGcsSource.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ImportProductSetsGcsSource.Builder
Overrides

clone()

public ImportProductSetsGcsSource.Builder clone()
Returns
Type Description
ImportProductSetsGcsSource.Builder
Overrides

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, the product-category column refers to product_category, and the labels column refers to 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 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;

Returns
Type Description
String

The csvFileUri.

getCsvFileUriBytes()

public 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, the product-category column refers to product_category, and the labels column refers to 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 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;

Returns
Type Description
ByteString

The bytes for csvFileUri.

getDefaultInstanceForType()

public ImportProductSetsGcsSource getDefaultInstanceForType()
Returns
Type Description
ImportProductSetsGcsSource

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ImportProductSetsGcsSource other)

public ImportProductSetsGcsSource.Builder mergeFrom(ImportProductSetsGcsSource other)
Parameter
Name Description
other ImportProductSetsGcsSource
Returns
Type Description
ImportProductSetsGcsSource.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ImportProductSetsGcsSource.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportProductSetsGcsSource.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ImportProductSetsGcsSource.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ImportProductSetsGcsSource.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ImportProductSetsGcsSource.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ImportProductSetsGcsSource.Builder
Overrides

setCsvFileUri(String value)

public ImportProductSetsGcsSource.Builder setCsvFileUri(String value)

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, the product-category column refers to product_category, and the labels column refers to 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 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;

Parameter
Name Description
value String

The csvFileUri to set.

Returns
Type Description
ImportProductSetsGcsSource.Builder

This builder for chaining.

setCsvFileUriBytes(ByteString value)

public ImportProductSetsGcsSource.Builder setCsvFileUriBytes(ByteString value)

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, the product-category column refers to product_category, and the labels column refers to 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 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;

Parameter
Name Description
value ByteString

The bytes for csvFileUri to set.

Returns
Type Description
ImportProductSetsGcsSource.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ImportProductSetsGcsSource.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ImportProductSetsGcsSource.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ImportProductSetsGcsSource.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ImportProductSetsGcsSource.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ImportProductSetsGcsSource.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ImportProductSetsGcsSource.Builder
Overrides