Class ImportProductSetsGcsSource (3.46.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.v1p3beta1.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 6 columns.

  1. image_uri 2, image_id
  2. product_set_id
  3. product_id 5, product_category 6, product_display_name 7, labels

  4. 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, the product_category field refers to 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;

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 6 columns.

  1. image_uri 2, image_id
  2. product_set_id
  3. product_id 5, product_category 6, product_display_name 7, labels

  4. 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, the product_category field refers to 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;

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