Package com.google.cloud.documentai.v1

Class BatchProcessRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.documentai.v1.BatchProcessRequest
All Implemented Interfaces:
BatchProcessRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class BatchProcessRequest extends com.google.protobuf.GeneratedMessage implements BatchProcessRequestOrBuilder
 Request message for
 [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments].
Protobuf type google.cloud.documentai.v1.BatchProcessRequest
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • INPUT_DOCUMENTS_FIELD_NUMBER

      public static final int INPUT_DOCUMENTS_FIELD_NUMBER
      See Also:

    • DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER

      public static final int DOCUMENT_OUTPUT_CONFIG_FIELD_NUMBER
      See Also:

    • SKIP_HUMAN_REVIEW_FIELD_NUMBER

      public static final int SKIP_HUMAN_REVIEW_FIELD_NUMBER
      See Also:

    • PROCESS_OPTIONS_FIELD_NUMBER

      public static final int PROCESS_OPTIONS_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public String getName()
       Required. The resource name of
 [Processor][google.cloud.documentai.v1.Processor] or
 [ProcessorVersion][google.cloud.documentai.v1.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.v1.Processor] or
 [ProcessorVersion][google.cloud.documentai.v1.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.

    • hasInputDocuments

      public boolean hasInputDocuments()
       The input documents for the
 [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments]
 method.
      .google.cloud.documentai.v1.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.v1.DocumentProcessorService.BatchProcessDocuments]
 method.
      .google.cloud.documentai.v1.BatchDocumentsInputConfig input_documents = 5;
      Specified by:
      getInputDocuments in interface BatchProcessRequestOrBuilder
      Returns:
      The inputDocuments.

    • getInputDocumentsOrBuilder

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

    • hasDocumentOutputConfig

      public boolean hasDocumentOutputConfig()
       The output configuration for the
 [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments]
 method.
      .google.cloud.documentai.v1.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.v1.DocumentProcessorService.BatchProcessDocuments]
 method.
      .google.cloud.documentai.v1.DocumentOutputConfig document_output_config = 6;
      Specified by:
      getDocumentOutputConfig in interface BatchProcessRequestOrBuilder
      Returns:
      The documentOutputConfig.

    • getDocumentOutputConfigOrBuilder

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

    • 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.v1.ProcessOptions process_options = 7;
      Specified by:
      hasProcessOptions in interface BatchProcessRequestOrBuilder
      Returns:
      Whether the processOptions field is set.

    • getProcessOptions

      public ProcessOptions getProcessOptions()
       Inference-time options for the process API
      .google.cloud.documentai.v1.ProcessOptions process_options = 7;
      Specified by:
      getProcessOptions in interface BatchProcessRequestOrBuilder
      Returns:
      The processOptions.

    • getProcessOptionsOrBuilder

      public ProcessOptionsOrBuilder getProcessOptionsOrBuilder()
       Inference-time options for the process API
      .google.cloud.documentai.v1.ProcessOptions process_options = 7;
      Specified by:
      getProcessOptionsOrBuilder in interface BatchProcessRequestOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: BatchProcessRequestOrBuilder
       Optional. The labels with user-defined metadata for the request.

 Label keys and values can be no longer than 63 characters
 (Unicode codepoints) and can only contain lowercase letters, numeric
 characters, underscores, and dashes. International characters are allowed.
 Label values are optional. Label keys must start with a letter.
      map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsCount in interface BatchProcessRequestOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       Optional. The labels with user-defined metadata for the request.

 Label keys and values can be no longer than 63 characters
 (Unicode codepoints) and can only contain lowercase letters, numeric
 characters, underscores, and dashes. International characters are allowed.
 Label values are optional. Label keys must start with a letter.
      map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsLabels in interface BatchProcessRequestOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface BatchProcessRequestOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       Optional. The labels with user-defined metadata for the request.

 Label keys and values can be no longer than 63 characters
 (Unicode codepoints) and can only contain lowercase letters, numeric
 characters, underscores, and dashes. International characters are allowed.
 Label values are optional. Label keys must start with a letter.
      map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsMap in interface BatchProcessRequestOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       Optional. The labels with user-defined metadata for the request.

 Label keys and values can be no longer than 63 characters
 (Unicode codepoints) and can only contain lowercase letters, numeric
 characters, underscores, and dashes. International characters are allowed.
 Label values are optional. Label keys must start with a letter.
      map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrDefault in interface BatchProcessRequestOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Optional. The labels with user-defined metadata for the request.

 Label keys and values can be no longer than 63 characters
 (Unicode codepoints) and can only contain lowercase letters, numeric
 characters, underscores, and dashes. International characters are allowed.
 Label values are optional. Label keys must start with a letter.
      map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrThrow in interface BatchProcessRequestOrBuilder

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static BatchProcessRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BatchProcessRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • 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

    • newBuilder

      public static BatchProcessRequest.Builder newBuilder()

    • newBuilder

      public static BatchProcessRequest.Builder newBuilder(BatchProcessRequest prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static BatchProcessRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<BatchProcessRequest> parser()

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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