Class ImportProductSetsGcsSource (3.31.0) 

public final class ImportProductSetsGcsSource extends 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.v1.ImportProductSetsGcsSource

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ImportProductSetsGcsSource

Static Fields

CSV_FILE_URI_FIELD_NUMBER

public static final int CSV_FILE_URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ImportProductSetsGcsSource getDefaultInstance()
Returns
Type Description
ImportProductSetsGcsSource

getDescriptor()

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

newBuilder()

public static ImportProductSetsGcsSource.Builder newBuilder()
Returns
Type Description
ImportProductSetsGcsSource.Builder

newBuilder(ImportProductSetsGcsSource prototype)

public static ImportProductSetsGcsSource.Builder newBuilder(ImportProductSetsGcsSource prototype)
Parameter
Name Description
prototype ImportProductSetsGcsSource
Returns
Type Description
ImportProductSetsGcsSource.Builder

parseDelimitedFrom(InputStream input)

public static ImportProductSetsGcsSource parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ImportProductSetsGcsSource
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportProductSetsGcsSource parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportProductSetsGcsSource
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ImportProductSetsGcsSource parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ImportProductSetsGcsSource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ImportProductSetsGcsSource parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportProductSetsGcsSource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ImportProductSetsGcsSource parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ImportProductSetsGcsSource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ImportProductSetsGcsSource parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportProductSetsGcsSource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ImportProductSetsGcsSource parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ImportProductSetsGcsSource
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportProductSetsGcsSource parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportProductSetsGcsSource
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ImportProductSetsGcsSource parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ImportProductSetsGcsSource
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportProductSetsGcsSource parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportProductSetsGcsSource
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ImportProductSetsGcsSource parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ImportProductSetsGcsSource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ImportProductSetsGcsSource parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportProductSetsGcsSource
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ImportProductSetsGcsSource> parser()
Returns
Type Description
Parser<ImportProductSetsGcsSource>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

getParserForType()

public Parser<ImportProductSetsGcsSource> getParserForType()
Returns
Type Description
Parser<ImportProductSetsGcsSource>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ImportProductSetsGcsSource.Builder newBuilderForType()
Returns
Type Description
ImportProductSetsGcsSource.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ImportProductSetsGcsSource.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ImportProductSetsGcsSource.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ImportProductSetsGcsSource.Builder toBuilder()
Returns
Type Description
ImportProductSetsGcsSource.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException