Class OutputConfig.Builder (3.42.0)

public static final class OutputConfig.Builder extends GeneratedMessageV3.Builder<OutputConfig.Builder> implements OutputConfigOrBuilder

The desired output location and metadata.

Protobuf type google.cloud.vision.v1p3beta1.OutputConfig

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public OutputConfig build()
Returns
Type Description
OutputConfig

buildPartial()

public OutputConfig buildPartial()
Returns
Type Description
OutputConfig

clear()

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

clearBatchSize()

public OutputConfig.Builder clearBatchSize()

The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20.

For example, for one pdf file with 100 pages, 100 response protos will be generated. If batch_size = 20, then 5 json files each containing 20 response protos will be written under the prefix gcs_destination.uri.

Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.

int32 batch_size = 2;

Returns
Type Description
OutputConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearGcsDestination()

public OutputConfig.Builder clearGcsDestination()

The Google Cloud Storage location to write the output(s) to.

.google.cloud.vision.v1p3beta1.GcsDestination gcs_destination = 1;

Returns
Type Description
OutputConfig.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

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

getBatchSize()

public int getBatchSize()

The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20.

For example, for one pdf file with 100 pages, 100 response protos will be generated. If batch_size = 20, then 5 json files each containing 20 response protos will be written under the prefix gcs_destination.uri.

Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.

int32 batch_size = 2;

Returns
Type Description
int

The batchSize.

getDefaultInstanceForType()

public OutputConfig getDefaultInstanceForType()
Returns
Type Description
OutputConfig

getDescriptorForType()

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

getGcsDestination()

public GcsDestination getGcsDestination()

The Google Cloud Storage location to write the output(s) to.

.google.cloud.vision.v1p3beta1.GcsDestination gcs_destination = 1;

Returns
Type Description
GcsDestination

The gcsDestination.

getGcsDestinationBuilder()

public GcsDestination.Builder getGcsDestinationBuilder()

The Google Cloud Storage location to write the output(s) to.

.google.cloud.vision.v1p3beta1.GcsDestination gcs_destination = 1;

Returns
Type Description
GcsDestination.Builder

getGcsDestinationOrBuilder()

public GcsDestinationOrBuilder getGcsDestinationOrBuilder()

The Google Cloud Storage location to write the output(s) to.

.google.cloud.vision.v1p3beta1.GcsDestination gcs_destination = 1;

Returns
Type Description
GcsDestinationOrBuilder

hasGcsDestination()

public boolean hasGcsDestination()

The Google Cloud Storage location to write the output(s) to.

.google.cloud.vision.v1p3beta1.GcsDestination gcs_destination = 1;

Returns
Type Description
boolean

Whether the gcsDestination field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(OutputConfig other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeGcsDestination(GcsDestination value)

public OutputConfig.Builder mergeGcsDestination(GcsDestination value)

The Google Cloud Storage location to write the output(s) to.

.google.cloud.vision.v1p3beta1.GcsDestination gcs_destination = 1;

Parameter
Name Description
value GcsDestination
Returns
Type Description
OutputConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setBatchSize(int value)

public OutputConfig.Builder setBatchSize(int value)

The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20.

For example, for one pdf file with 100 pages, 100 response protos will be generated. If batch_size = 20, then 5 json files each containing 20 response protos will be written under the prefix gcs_destination.uri.

Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.

int32 batch_size = 2;

Parameter
Name Description
value int

The batchSize to set.

Returns
Type Description
OutputConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setGcsDestination(GcsDestination value)

public OutputConfig.Builder setGcsDestination(GcsDestination value)

The Google Cloud Storage location to write the output(s) to.

.google.cloud.vision.v1p3beta1.GcsDestination gcs_destination = 1;

Parameter
Name Description
value GcsDestination
Returns
Type Description
OutputConfig.Builder

setGcsDestination(GcsDestination.Builder builderForValue)

public OutputConfig.Builder setGcsDestination(GcsDestination.Builder builderForValue)

The Google Cloud Storage location to write the output(s) to.

.google.cloud.vision.v1p3beta1.GcsDestination gcs_destination = 1;

Parameter
Name Description
builderForValue GcsDestination.Builder
Returns
Type Description
OutputConfig.Builder

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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