Package com.google.cloud.documentai.v1

Interface BatchProcessRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
BatchProcessRequest, BatchProcessRequest.Builder
@Generated public interface BatchProcessRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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) = { ... }
      Returns:
      The name.

    • getNameBytes

      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) = { ... }
      Returns:
      The bytes for name.

    • hasInputDocuments

      boolean hasInputDocuments()
       The input documents for the
 [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments]
 method.
      .google.cloud.documentai.v1.BatchDocumentsInputConfig input_documents = 5;
      Returns:
      Whether the inputDocuments field is set.

    • getInputDocuments

      BatchDocumentsInputConfig getInputDocuments()
       The input documents for the
 [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments]
 method.
      .google.cloud.documentai.v1.BatchDocumentsInputConfig input_documents = 5;
      Returns:
      The inputDocuments.

    • getInputDocumentsOrBuilder

      BatchDocumentsInputConfigOrBuilder getInputDocumentsOrBuilder()
       The input documents for the
 [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments]
 method.
      .google.cloud.documentai.v1.BatchDocumentsInputConfig input_documents = 5;

    • hasDocumentOutputConfig

      boolean hasDocumentOutputConfig()
       The output configuration for the
 [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments]
 method.
      .google.cloud.documentai.v1.DocumentOutputConfig document_output_config = 6;
      Returns:
      Whether the documentOutputConfig field is set.

    • getDocumentOutputConfig

      DocumentOutputConfig getDocumentOutputConfig()
       The output configuration for the
 [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments]
 method.
      .google.cloud.documentai.v1.DocumentOutputConfig document_output_config = 6;
      Returns:
      The documentOutputConfig.

    • getDocumentOutputConfigOrBuilder

      DocumentOutputConfigOrBuilder getDocumentOutputConfigOrBuilder()
       The output configuration for the
 [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments]
 method.
      .google.cloud.documentai.v1.DocumentOutputConfig document_output_config = 6;

    • getSkipHumanReview

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

    • hasProcessOptions

      boolean hasProcessOptions()
       Inference-time options for the process API
      .google.cloud.documentai.v1.ProcessOptions process_options = 7;
      Returns:
      Whether the processOptions field is set.

    • getProcessOptions

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

    • getProcessOptionsOrBuilder

      ProcessOptionsOrBuilder getProcessOptionsOrBuilder()
       Inference-time options for the process API
      .google.cloud.documentai.v1.ProcessOptions process_options = 7;

    • getLabelsCount

      int getLabelsCount()
       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];

    • containsLabels

      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];

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      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];

    • getLabelsOrDefault

      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];

    • getLabelsOrThrow

      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];