Interface OutputConfigOrBuilder (2.40.0)

public interface OutputConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDestinationCase()

public abstract OutputConfig.DestinationCase getDestinationCase()

Returns
Type	Description
`OutputConfig.DestinationCase`

getGcsDestination()

public abstract GcsDestination getGcsDestination()

The Google Cloud Storage location to write the output to.

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

Returns
Type	Description
`GcsDestination`	The gcsDestination.

getGcsDestinationOrBuilder()

public abstract GcsDestinationOrBuilder getGcsDestinationOrBuilder()

The Google Cloud Storage location to write the output to.

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

Returns
Type	Description
`GcsDestinationOrBuilder`

getPagesPerShard()

public abstract 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
Type	Description
`int`	The pagesPerShard.

hasGcsDestination()

public abstract boolean hasGcsDestination()

The Google Cloud Storage location to write the output to.

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

Returns
Type	Description
`boolean`	Whether the gcsDestination field is set.