Class OutputConfig.Builder (2.41.0)

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

The desired output location and metadata.

Protobuf type google.cloud.documentai.v1beta1.OutputConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public OutputConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
OutputConfig.Builder
Overrides

build()

public OutputConfig build()
Returns
TypeDescription
OutputConfig

buildPartial()

public OutputConfig buildPartial()
Returns
TypeDescription
OutputConfig

clear()

public OutputConfig.Builder clear()
Returns
TypeDescription
OutputConfig.Builder
Overrides

clearDestination()

public OutputConfig.Builder clearDestination()
Returns
TypeDescription
OutputConfig.Builder

clearField(Descriptors.FieldDescriptor field)

public OutputConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
OutputConfig.Builder
Overrides

clearGcsDestination()

public OutputConfig.Builder clearGcsDestination()

The Google Cloud Storage location to write the output to.

.google.cloud.documentai.v1beta1.GcsDestination gcs_destination = 1;

Returns
TypeDescription
OutputConfig.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public OutputConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
OutputConfig.Builder
Overrides

clearPagesPerShard()

public OutputConfig.Builder clearPagesPerShard()

The max number of pages to include into each output Document shard JSON 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 parsed pages will be produced. If pages_per_shard = 20, then 5 Document shard JSON files each containing 20 parsed pages will be written under the prefix [OutputConfig.gcs_destination.uri][] and suffix pages-x-to-y.json where x and y are 1-indexed page numbers.

Example GCS outputs with 157 pages and pages_per_shard = 50:

<prefix>pages-001-to-050.json <prefix>pages-051-to-100.json <prefix>pages-101-to-150.json <prefix>pages-151-to-157.json

int32 pages_per_shard = 2;

Returns
TypeDescription
OutputConfig.Builder

This builder for chaining.

clone()

public OutputConfig.Builder clone()
Returns
TypeDescription
OutputConfig.Builder
Overrides

getDefaultInstanceForType()

public OutputConfig getDefaultInstanceForType()
Returns
TypeDescription
OutputConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDestinationCase()

public OutputConfig.DestinationCase getDestinationCase()
Returns
TypeDescription
OutputConfig.DestinationCase

getGcsDestination()

public GcsDestination getGcsDestination()

The Google Cloud Storage location to write the output to.

.google.cloud.documentai.v1beta1.GcsDestination gcs_destination = 1;

Returns
TypeDescription
GcsDestination

The gcsDestination.

getGcsDestinationBuilder()

public GcsDestination.Builder getGcsDestinationBuilder()

The Google Cloud Storage location to write the output to.

.google.cloud.documentai.v1beta1.GcsDestination gcs_destination = 1;

Returns
TypeDescription
GcsDestination.Builder

getGcsDestinationOrBuilder()

public GcsDestinationOrBuilder getGcsDestinationOrBuilder()

The Google Cloud Storage location to write the output to.

.google.cloud.documentai.v1beta1.GcsDestination gcs_destination = 1;

Returns
TypeDescription
GcsDestinationOrBuilder

getPagesPerShard()

public int getPagesPerShard()

The max number of pages to include into each output Document shard JSON 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 parsed pages will be produced. If pages_per_shard = 20, then 5 Document shard JSON files each containing 20 parsed pages will be written under the prefix [OutputConfig.gcs_destination.uri][] and suffix pages-x-to-y.json where x and y are 1-indexed page numbers.

Example GCS outputs with 157 pages and pages_per_shard = 50:

<prefix>pages-001-to-050.json <prefix>pages-051-to-100.json <prefix>pages-101-to-150.json <prefix>pages-151-to-157.json

int32 pages_per_shard = 2;

Returns
TypeDescription
int

The pagesPerShard.

hasGcsDestination()

public boolean hasGcsDestination()

The Google Cloud Storage location to write the output to.

.google.cloud.documentai.v1beta1.GcsDestination gcs_destination = 1;

Returns
TypeDescription
boolean

Whether the gcsDestination field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(OutputConfig other)

public OutputConfig.Builder mergeFrom(OutputConfig other)
Parameter
NameDescription
otherOutputConfig
Returns
TypeDescription
OutputConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public OutputConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OutputConfig.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public OutputConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
OutputConfig.Builder
Overrides

mergeGcsDestination(GcsDestination value)

public OutputConfig.Builder mergeGcsDestination(GcsDestination value)

The Google Cloud Storage location to write the output to.

.google.cloud.documentai.v1beta1.GcsDestination gcs_destination = 1;

Parameter
NameDescription
valueGcsDestination
Returns
TypeDescription
OutputConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final OutputConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
OutputConfig.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public OutputConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
OutputConfig.Builder
Overrides

setGcsDestination(GcsDestination value)

public OutputConfig.Builder setGcsDestination(GcsDestination value)

The Google Cloud Storage location to write the output to.

.google.cloud.documentai.v1beta1.GcsDestination gcs_destination = 1;

Parameter
NameDescription
valueGcsDestination
Returns
TypeDescription
OutputConfig.Builder

setGcsDestination(GcsDestination.Builder builderForValue)

public OutputConfig.Builder setGcsDestination(GcsDestination.Builder builderForValue)

The Google Cloud Storage location to write the output to.

.google.cloud.documentai.v1beta1.GcsDestination gcs_destination = 1;

Parameter
NameDescription
builderForValueGcsDestination.Builder
Returns
TypeDescription
OutputConfig.Builder

setPagesPerShard(int value)

public OutputConfig.Builder setPagesPerShard(int value)

The max number of pages to include into each output Document shard JSON 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 parsed pages will be produced. If pages_per_shard = 20, then 5 Document shard JSON files each containing 20 parsed pages will be written under the prefix [OutputConfig.gcs_destination.uri][] and suffix pages-x-to-y.json where x and y are 1-indexed page numbers.

Example GCS outputs with 157 pages and pages_per_shard = 50:

<prefix>pages-001-to-050.json <prefix>pages-051-to-100.json <prefix>pages-101-to-150.json <prefix>pages-151-to-157.json

int32 pages_per_shard = 2;

Parameter
NameDescription
valueint

The pagesPerShard to set.

Returns
TypeDescription
OutputConfig.Builder

This builder for chaining.

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

public OutputConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
OutputConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final OutputConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
OutputConfig.Builder
Overrides