Package com.google.cloud.documentai.v1beta3

Class BatchProcessRequest

  • All Implemented Interfaces:
    BatchProcessRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class BatchProcessRequest
extends com.google.protobuf.GeneratedMessageV3
implements BatchProcessRequestOrBuilder
     Request message for
 [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments].
    Protobuf type google.cloud.documentai.v1beta3.BatchProcessRequest
    See Also:
    Serialized Form

    • Field Detail

      • INPUT_CONFIGS_FIELD_NUMBER

        public static final int INPUT_CONFIGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OUTPUT_CONFIG_FIELD_NUMBER

        public static final int OUTPUT_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INPUT_DOCUMENTS_FIELD_NUMBER

        public static final int INPUT_DOCUMENTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER

        public static final int DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SKIP_HUMAN_REVIEW_FIELD_NUMBER

        public static final int SKIP_HUMAN_REVIEW_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PROCESS_OPTIONS_FIELD_NUMBER

        public static final int PROCESS_OPTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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

      • getName

        public String getName()
         Required. The resource name of
 [Processor][google.cloud.documentai.v1beta3.Processor] or
 [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion].
 Format: `projects/{project}/locations/{location}/processors/{processor}`,
 or
 `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getName in interface BatchProcessRequestOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Required. The resource name of
 [Processor][google.cloud.documentai.v1beta3.Processor] or
 [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion].
 Format: `projects/{project}/locations/{location}/processors/{processor}`,
 or
 `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getNameBytes in interface BatchProcessRequestOrBuilder
        Returns:
        The bytes for name.

      • getInputConfigsCount

        @Deprecated
public int getInputConfigsCount()
        Deprecated.
         The input config for each single document in the batch process.
        repeated .google.cloud.documentai.v1beta3.BatchProcessRequest.BatchInputConfig input_configs = 2 [deprecated = true];
        Specified by:
        getInputConfigsCount in interface BatchProcessRequestOrBuilder

      • hasOutputConfig

        @Deprecated
public boolean hasOutputConfig()
        Deprecated.
        google.cloud.documentai.v1beta3.BatchProcessRequest.output_config is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=502
         The overall output config for batch process.
        .google.cloud.documentai.v1beta3.BatchProcessRequest.BatchOutputConfig output_config = 3 [deprecated = true];
        Specified by:
        hasOutputConfig in interface BatchProcessRequestOrBuilder
        Returns:
        Whether the outputConfig field is set.

      • getOutputConfig

        @Deprecated
public BatchProcessRequest.BatchOutputConfig getOutputConfig()
        Deprecated.
        google.cloud.documentai.v1beta3.BatchProcessRequest.output_config is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=502
         The overall output config for batch process.
        .google.cloud.documentai.v1beta3.BatchProcessRequest.BatchOutputConfig output_config = 3 [deprecated = true];
        Specified by:
        getOutputConfig in interface BatchProcessRequestOrBuilder
        Returns:
        The outputConfig.

      • hasInputDocuments

        public boolean hasInputDocuments()
         The input documents for the
 [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
 method.
        .google.cloud.documentai.v1beta3.BatchDocumentsInputConfig input_documents = 5;
        Specified by:
        hasInputDocuments in interface BatchProcessRequestOrBuilder
        Returns:
        Whether the inputDocuments field is set.

      • getInputDocuments

        public BatchDocumentsInputConfig getInputDocuments()
         The input documents for the
 [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
 method.
        .google.cloud.documentai.v1beta3.BatchDocumentsInputConfig input_documents = 5;
        Specified by:
        getInputDocuments in interface BatchProcessRequestOrBuilder
        Returns:
        The inputDocuments.

      • hasDocumentOutputConfig

        public boolean hasDocumentOutputConfig()
         The output configuration for the
 [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
 method.
        .google.cloud.documentai.v1beta3.DocumentOutputConfig document_output_config = 6;
        Specified by:
        hasDocumentOutputConfig in interface BatchProcessRequestOrBuilder
        Returns:
        Whether the documentOutputConfig field is set.

      • getDocumentOutputConfig

        public DocumentOutputConfig getDocumentOutputConfig()
         The output configuration for the
 [BatchProcessDocuments][google.cloud.documentai.v1beta3.DocumentProcessorService.BatchProcessDocuments]
 method.
        .google.cloud.documentai.v1beta3.DocumentOutputConfig document_output_config = 6;
        Specified by:
        getDocumentOutputConfig in interface BatchProcessRequestOrBuilder
        Returns:
        The documentOutputConfig.

      • getSkipHumanReview

        public boolean getSkipHumanReview()
         Whether human review should be skipped for this request. Default to
 `false`.
        bool skip_human_review = 4;
        Specified by:
        getSkipHumanReview in interface BatchProcessRequestOrBuilder
        Returns:
        The skipHumanReview.

      • hasProcessOptions

        public boolean hasProcessOptions()
         Inference-time options for the process API
        .google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;
        Specified by:
        hasProcessOptions in interface BatchProcessRequestOrBuilder
        Returns:
        Whether the processOptions field is set.

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static BatchProcessRequest parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BatchProcessRequest parseFrom​(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BatchProcessRequest parseFrom​(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BatchProcessRequest parseFrom​(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BatchProcessRequest parseFrom​(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BatchProcessRequest parseFrom​(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static BatchProcessRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
        Throws:
        IOException

      • newBuilderForType

        public BatchProcessRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public BatchProcessRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected BatchProcessRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<BatchProcessRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

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