Package com.google.cloud.documentai.v1beta1

Class OutputConfig.Builder

  • All Implemented Interfaces:
    OutputConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    OutputConfig
    public static final class OutputConfig.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<OutputConfig.Builder>
implements OutputConfigOrBuilder
     The desired output location and metadata.
    Protobuf type google.cloud.documentai.v1beta1.OutputConfig

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<OutputConfig.Builder>

      • clear

        public OutputConfig.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<OutputConfig.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<OutputConfig.Builder>

      • getDefaultInstanceForType

        public OutputConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public OutputConfig build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public OutputConfig buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public OutputConfig.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<OutputConfig.Builder>

      • setField

        public OutputConfig.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                     Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<OutputConfig.Builder>

      • clearField

        public OutputConfig.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<OutputConfig.Builder>

      • clearOneof

        public OutputConfig.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<OutputConfig.Builder>

      • setRepeatedField

        public OutputConfig.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             int index,
                                             Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<OutputConfig.Builder>

      • addRepeatedField

        public OutputConfig.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<OutputConfig.Builder>

      • mergeFrom

        public OutputConfig.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<OutputConfig.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<OutputConfig.Builder>

      • mergeFrom

        public OutputConfig.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<OutputConfig.Builder>
        Throws:
        IOException

      • hasGcsDestination

        public boolean hasGcsDestination()
         The Google Cloud Storage location to write the output to.
        .google.cloud.documentai.v1beta1.GcsDestination gcs_destination = 1;
        Specified by:
        hasGcsDestination in interface OutputConfigOrBuilder
        Returns:
        Whether the gcsDestination field is set.

      • getGcsDestination

        public GcsDestination getGcsDestination()
         The Google Cloud Storage location to write the output to.
        .google.cloud.documentai.v1beta1.GcsDestination gcs_destination = 1;
        Specified by:
        getGcsDestination in interface OutputConfigOrBuilder
        Returns:
        The gcsDestination.

      • setGcsDestination

        public OutputConfig.Builder setGcsDestination​(GcsDestination value)
         The Google Cloud Storage location to write the output to.
        .google.cloud.documentai.v1beta1.GcsDestination gcs_destination = 1;

      • setGcsDestination

        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;

      • mergeGcsDestination

        public OutputConfig.Builder mergeGcsDestination​(GcsDestination value)
         The Google Cloud Storage location to write the output to.
        .google.cloud.documentai.v1beta1.GcsDestination gcs_destination = 1;

      • clearGcsDestination

        public OutputConfig.Builder clearGcsDestination()
         The Google Cloud Storage location to write the output to.
        .google.cloud.documentai.v1beta1.GcsDestination gcs_destination = 1;

      • getGcsDestinationBuilder

        public GcsDestination.Builder getGcsDestinationBuilder()
         The Google Cloud Storage location to write the output to.
        .google.cloud.documentai.v1beta1.GcsDestination gcs_destination = 1;

      • 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;
        Specified by:
        getPagesPerShard in interface OutputConfigOrBuilder
        Returns:
        The pagesPerShard.

      • setPagesPerShard

        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;
        Parameters:
        value - The pagesPerShard to set.
        Returns:
        This builder for chaining.

      • 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:
        This builder for chaining.

      • setUnknownFields

        public final OutputConfig.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<OutputConfig.Builder>

      • mergeUnknownFields

        public final OutputConfig.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<OutputConfig.Builder>