com.google.cloud.documentai.v1beta2

Interface OutputConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

OutputConfig, OutputConfig.Builder

public interface OutputConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
OutputConfig.DestinationCase	getDestinationCase()
GcsDestination	getGcsDestination() The Google Cloud Storage location to write the output to.
GcsDestinationOrBuilder	getGcsDestinationOrBuilder() The Google Cloud Storage location to write the output to.
int	getPagesPerShard() The max number of pages to include into each output Document shard JSON on Google Cloud Storage.
boolean	hasGcsDestination() The Google Cloud Storage location to write the output to.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasGcsDestination

boolean hasGcsDestination()

 The Google Cloud Storage location to write the output to.
 

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

Returns:

Whether the gcsDestination field is set.

getGcsDestination

GcsDestination getGcsDestination()

 The Google Cloud Storage location to write the output to.
 

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

Returns:

The gcsDestination.

getGcsDestinationOrBuilder

GcsDestinationOrBuilder getGcsDestinationOrBuilder()

 The Google Cloud Storage location to write the output to.
 

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

getPagesPerShard

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:

The pagesPerShard.

getDestinationCase

OutputConfig.DestinationCase getDestinationCase()