Package com.google.cloud.documentai.v1

Interface ProcessRequestOrBuilder

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

  • Method Details

    • hasInlineDocument

      boolean hasInlineDocument()
       An inline document proto.
      .google.cloud.documentai.v1.Document inline_document = 4;
      Returns:
      Whether the inlineDocument field is set.

    • getInlineDocument

      Document getInlineDocument()
       An inline document proto.
      .google.cloud.documentai.v1.Document inline_document = 4;
      Returns:
      The inlineDocument.

    • getInlineDocumentOrBuilder

      DocumentOrBuilder getInlineDocumentOrBuilder()
       An inline document proto.
      .google.cloud.documentai.v1.Document inline_document = 4;

    • hasRawDocument

      boolean hasRawDocument()
       A raw document content (bytes).
      .google.cloud.documentai.v1.RawDocument raw_document = 5;
      Returns:
      Whether the rawDocument field is set.

    • getRawDocument

      RawDocument getRawDocument()
       A raw document content (bytes).
      .google.cloud.documentai.v1.RawDocument raw_document = 5;
      Returns:
      The rawDocument.

    • getRawDocumentOrBuilder

      RawDocumentOrBuilder getRawDocumentOrBuilder()
       A raw document content (bytes).
      .google.cloud.documentai.v1.RawDocument raw_document = 5;

    • hasGcsDocument

      boolean hasGcsDocument()
       A raw document on Google Cloud Storage.
      .google.cloud.documentai.v1.GcsDocument gcs_document = 8;
      Returns:
      Whether the gcsDocument field is set.

    • getGcsDocument

      GcsDocument getGcsDocument()
       A raw document on Google Cloud Storage.
      .google.cloud.documentai.v1.GcsDocument gcs_document = 8;
      Returns:
      The gcsDocument.

    • getGcsDocumentOrBuilder

      GcsDocumentOrBuilder getGcsDocumentOrBuilder()
       A raw document on Google Cloud Storage.
      .google.cloud.documentai.v1.GcsDocument gcs_document = 8;

    • getName

      String getName()
       Required. The resource name of the
 [Processor][google.cloud.documentai.v1.Processor] or
 [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]
 to use for processing. If a
 [Processor][google.cloud.documentai.v1.Processor] is specified, the server
 will use its [default
 version][google.cloud.documentai.v1.Processor.default_processor_version].
 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 the
 [Processor][google.cloud.documentai.v1.Processor] or
 [ProcessorVersion][google.cloud.documentai.v1.ProcessorVersion]
 to use for processing. If a
 [Processor][google.cloud.documentai.v1.Processor] is specified, the server
 will use its [default
 version][google.cloud.documentai.v1.Processor.default_processor_version].
 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.

    • getSkipHumanReview

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

    • hasFieldMask

      boolean hasFieldMask()
       Specifies which fields to include in the
 [ProcessResponse.document][google.cloud.documentai.v1.ProcessResponse.document]
 output. Only supports top-level document and pages field, so it must be in
 the form of `{document_field_name}` or `pages.{page_field_name}`.
      .google.protobuf.FieldMask field_mask = 6;
      Returns:
      Whether the fieldMask field is set.

    • getFieldMask

      com.google.protobuf.FieldMask getFieldMask()
       Specifies which fields to include in the
 [ProcessResponse.document][google.cloud.documentai.v1.ProcessResponse.document]
 output. Only supports top-level document and pages field, so it must be in
 the form of `{document_field_name}` or `pages.{page_field_name}`.
      .google.protobuf.FieldMask field_mask = 6;
      Returns:
      The fieldMask.

    • getFieldMaskOrBuilder

      com.google.protobuf.FieldMaskOrBuilder getFieldMaskOrBuilder()
       Specifies which fields to include in the
 [ProcessResponse.document][google.cloud.documentai.v1.ProcessResponse.document]
 output. Only supports top-level document and pages field, so it must be in
 the form of `{document_field_name}` or `pages.{page_field_name}`.
      .google.protobuf.FieldMask field_mask = 6;

    • 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 = 10 [(.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 = 10 [(.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 = 10 [(.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 = 10 [(.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 = 10 [(.google.api.field_behavior) = OPTIONAL];

    • getImagelessMode

      boolean getImagelessMode()
       Optional. Option to remove images from the document.
      bool imageless_mode = 11 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The imagelessMode.

    • getSourceCase

      ProcessRequest.SourceCase getSourceCase()