Package com.google.cloud.documentai.v1

Class ProcessRequest

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

  • Field Details

    • INLINE_DOCUMENT_FIELD_NUMBER

      public static final int INLINE_DOCUMENT_FIELD_NUMBER
      See Also:

    • RAW_DOCUMENT_FIELD_NUMBER

      public static final int RAW_DOCUMENT_FIELD_NUMBER
      See Also:

    • GCS_DOCUMENT_FIELD_NUMBER

      public static final int GCS_DOCUMENT_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • SKIP_HUMAN_REVIEW_FIELD_NUMBER

      public static final int SKIP_HUMAN_REVIEW_FIELD_NUMBER
      See Also:

    • FIELD_MASK_FIELD_NUMBER

      public static final int FIELD_MASK_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:

    • IMAGELESS_MODE_FIELD_NUMBER

      public static final int IMAGELESS_MODE_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

    • getSourceCase

      public ProcessRequest.SourceCase getSourceCase()
      Specified by:
      getSourceCase in interface ProcessRequestOrBuilder

    • hasInlineDocument

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

    • getInlineDocument

      public Document getInlineDocument()
       An inline document proto.
      .google.cloud.documentai.v1.Document inline_document = 4;
      Specified by:
      getInlineDocument in interface ProcessRequestOrBuilder
      Returns:
      The inlineDocument.

    • getInlineDocumentOrBuilder

      public DocumentOrBuilder getInlineDocumentOrBuilder()
       An inline document proto.
      .google.cloud.documentai.v1.Document inline_document = 4;
      Specified by:
      getInlineDocumentOrBuilder in interface ProcessRequestOrBuilder

    • hasRawDocument

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

    • getRawDocument

      public RawDocument getRawDocument()
       A raw document content (bytes).
      .google.cloud.documentai.v1.RawDocument raw_document = 5;
      Specified by:
      getRawDocument in interface ProcessRequestOrBuilder
      Returns:
      The rawDocument.

    • getRawDocumentOrBuilder

      public RawDocumentOrBuilder getRawDocumentOrBuilder()
       A raw document content (bytes).
      .google.cloud.documentai.v1.RawDocument raw_document = 5;
      Specified by:
      getRawDocumentOrBuilder in interface ProcessRequestOrBuilder

    • hasGcsDocument

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

    • getGcsDocument

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

    • getGcsDocumentOrBuilder

      public GcsDocumentOrBuilder getGcsDocumentOrBuilder()
       A raw document on Google Cloud Storage.
      .google.cloud.documentai.v1.GcsDocument gcs_document = 8;
      Specified by:
      getGcsDocumentOrBuilder in interface ProcessRequestOrBuilder

    • getName

      public 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) = { ... }
      Specified by:
      getName in interface ProcessRequestOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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) = { ... }
      Specified by:
      getNameBytes in interface ProcessRequestOrBuilder
      Returns:
      The bytes for name.

    • getSkipHumanReview

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

    • hasFieldMask

      public 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;
      Specified by:
      hasFieldMask in interface ProcessRequestOrBuilder
      Returns:
      Whether the fieldMask field is set.

    • getFieldMask

      public 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;
      Specified by:
      getFieldMask in interface ProcessRequestOrBuilder
      Returns:
      The fieldMask.

    • getFieldMaskOrBuilder

      public 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;
      Specified by:
      getFieldMaskOrBuilder in interface ProcessRequestOrBuilder

    • hasProcessOptions

      public boolean hasProcessOptions()
       Inference-time options for the process API
      .google.cloud.documentai.v1.ProcessOptions process_options = 7;
      Specified by:
      hasProcessOptions in interface ProcessRequestOrBuilder
      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 ProcessRequestOrBuilder
      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 ProcessRequestOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: ProcessRequestOrBuilder
       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];
      Specified by:
      getLabelsCount in interface ProcessRequestOrBuilder

    • 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 = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsLabels in interface ProcessRequestOrBuilder

    • getLabels

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

    • 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 = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsMap in interface ProcessRequestOrBuilder

    • 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 = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrDefault in interface ProcessRequestOrBuilder

    • 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 = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrThrow in interface ProcessRequestOrBuilder

    • getImagelessMode

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

    • 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 ProcessRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static ProcessRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ProcessRequest.Builder newBuilder()

    • newBuilder

      public static ProcessRequest.Builder newBuilder(ProcessRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected ProcessRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ProcessRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ProcessRequest> 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 ProcessRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder