Class GcsDestination.Builder (3.42.0)

public static final class GcsDestination.Builder extends GeneratedMessageV3.Builder<GcsDestination.Builder> implements GcsDestinationOrBuilder

The Google Cloud Storage location where the output will be written to.

Protobuf type google.cloud.vision.v1.GcsDestination

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public GcsDestination build()
Returns
Type Description
GcsDestination

buildPartial()

public GcsDestination buildPartial()
Returns
Type Description
GcsDestination

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearUri()

public GcsDestination.Builder clearUri()

Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide.

Examples:

  • File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix".

  • Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified.

    If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.

string uri = 1;

Returns
Type Description
GcsDestination.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public GcsDestination getDefaultInstanceForType()
Returns
Type Description
GcsDestination

getDescriptorForType()

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

getUri()

public String getUri()

Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide.

Examples:

  • File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix".

  • Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified.

    If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.

string uri = 1;

Returns
Type Description
String

The uri.

getUriBytes()

public ByteString getUriBytes()

Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide.

Examples:

  • File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix".

  • Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified.

    If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.

string uri = 1;

Returns
Type Description
ByteString

The bytes for uri.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(GcsDestination other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

setUri(String value)

public GcsDestination.Builder setUri(String value)

Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide.

Examples:

  • File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix".

  • Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified.

    If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.

string uri = 1;

Parameter
Name Description
value String

The uri to set.

Returns
Type Description
GcsDestination.Builder

This builder for chaining.

setUriBytes(ByteString value)

public GcsDestination.Builder setUriBytes(ByteString value)

Google Cloud Storage URI prefix where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI prefix. This field can either represent a gcs file prefix or gcs directory. In either case, the uri should be unique because in order to get all of the output files, you will need to do a wildcard gcs search on the uri prefix you provide.

Examples:

  • File Prefix: gs://bucket-name/here/filenameprefix The output files will be created in gs://bucket-name/here/ and the names of the output files will begin with "filenameprefix".

  • Directory Prefix: gs://bucket-name/some/location/ The output files will be created in gs://bucket-name/some/location/ and the names of the output files could be anything because there was no filename prefix specified.

    If multiple outputs, each response is still AnnotateFileResponse, each of which contains some subset of the full list of AnnotateImageResponse. Multiple outputs can happen if, for example, the output JSON is too large and overflows into multiple sharded files.

string uri = 1;

Parameter
Name Description
value ByteString

The bytes for uri to set.

Returns
Type Description
GcsDestination.Builder

This builder for chaining.