Package com.google.cloud.documentai.v1beta3

Class ProcessRequest.Builder

  • All Implemented Interfaces:
    ProcessRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    ProcessRequest
    public static final class ProcessRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>
implements ProcessRequestOrBuilder
     Request message for the
 [ProcessDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ProcessDocument]
 method.
    Protobuf type google.cloud.documentai.v1beta3.ProcessRequest

    • Method Detail

      • 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.Builder<ProcessRequest.Builder>

      • clear

        public ProcessRequest.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public ProcessRequest.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>

      • setField

        public ProcessRequest.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>

      • clearField

        public ProcessRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>

      • clearOneof

        public ProcessRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>

      • setRepeatedField

        public ProcessRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               int index,
                                               Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>

      • addRepeatedField

        public ProcessRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>

      • mergeFrom

        public ProcessRequest.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ProcessRequest.Builder>

      • isInitialized

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

      • mergeFrom

        public ProcessRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ProcessRequest.Builder>
        Throws:
        IOException

      • hasInlineDocument

        public boolean hasInlineDocument()
         An inline document proto.
        .google.cloud.documentai.v1beta3.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.v1beta3.Document inline_document = 4;
        Specified by:
        getInlineDocument in interface ProcessRequestOrBuilder
        Returns:
        The inlineDocument.

      • setInlineDocument

        public ProcessRequest.Builder setInlineDocument​(Document value)
         An inline document proto.
        .google.cloud.documentai.v1beta3.Document inline_document = 4;

      • setInlineDocument

        public ProcessRequest.Builder setInlineDocument​(Document.Builder builderForValue)
         An inline document proto.
        .google.cloud.documentai.v1beta3.Document inline_document = 4;

      • mergeInlineDocument

        public ProcessRequest.Builder mergeInlineDocument​(Document value)
         An inline document proto.
        .google.cloud.documentai.v1beta3.Document inline_document = 4;

      • clearInlineDocument

        public ProcessRequest.Builder clearInlineDocument()
         An inline document proto.
        .google.cloud.documentai.v1beta3.Document inline_document = 4;

      • getInlineDocumentBuilder

        public Document.Builder getInlineDocumentBuilder()
         An inline document proto.
        .google.cloud.documentai.v1beta3.Document inline_document = 4;

      • hasRawDocument

        public boolean hasRawDocument()
         A raw document content (bytes).
        .google.cloud.documentai.v1beta3.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.v1beta3.RawDocument raw_document = 5;
        Specified by:
        getRawDocument in interface ProcessRequestOrBuilder
        Returns:
        The rawDocument.

      • setRawDocument

        public ProcessRequest.Builder setRawDocument​(RawDocument value)
         A raw document content (bytes).
        .google.cloud.documentai.v1beta3.RawDocument raw_document = 5;

      • mergeRawDocument

        public ProcessRequest.Builder mergeRawDocument​(RawDocument value)
         A raw document content (bytes).
        .google.cloud.documentai.v1beta3.RawDocument raw_document = 5;

      • clearRawDocument

        public ProcessRequest.Builder clearRawDocument()
         A raw document content (bytes).
        .google.cloud.documentai.v1beta3.RawDocument raw_document = 5;

      • getRawDocumentBuilder

        public RawDocument.Builder getRawDocumentBuilder()
         A raw document content (bytes).
        .google.cloud.documentai.v1beta3.RawDocument raw_document = 5;

      • hasGcsDocument

        public boolean hasGcsDocument()
         A raw document on Google Cloud Storage.
        .google.cloud.documentai.v1beta3.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.v1beta3.GcsDocument gcs_document = 8;
        Specified by:
        getGcsDocument in interface ProcessRequestOrBuilder
        Returns:
        The gcsDocument.

      • setGcsDocument

        public ProcessRequest.Builder setGcsDocument​(GcsDocument value)
         A raw document on Google Cloud Storage.
        .google.cloud.documentai.v1beta3.GcsDocument gcs_document = 8;

      • setGcsDocument

        public ProcessRequest.Builder setGcsDocument​(GcsDocument.Builder builderForValue)
         A raw document on Google Cloud Storage.
        .google.cloud.documentai.v1beta3.GcsDocument gcs_document = 8;

      • mergeGcsDocument

        public ProcessRequest.Builder mergeGcsDocument​(GcsDocument value)
         A raw document on Google Cloud Storage.
        .google.cloud.documentai.v1beta3.GcsDocument gcs_document = 8;

      • clearGcsDocument

        public ProcessRequest.Builder clearGcsDocument()
         A raw document on Google Cloud Storage.
        .google.cloud.documentai.v1beta3.GcsDocument gcs_document = 8;

      • getGcsDocumentBuilder

        public GcsDocument.Builder getGcsDocumentBuilder()
         A raw document on Google Cloud Storage.
        .google.cloud.documentai.v1beta3.GcsDocument gcs_document = 8;

      • getName

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

      • setName

        public ProcessRequest.Builder setName​(String value)
         Required. The resource name of the
 [Processor][google.cloud.documentai.v1beta3.Processor] or
 [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion]
 to use for processing. If a
 [Processor][google.cloud.documentai.v1beta3.Processor] is specified, the
 server will use its [default
 version][google.cloud.documentai.v1beta3.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) = { ... }
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public ProcessRequest.Builder clearName()
         Required. The resource name of the
 [Processor][google.cloud.documentai.v1beta3.Processor] or
 [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion]
 to use for processing. If a
 [Processor][google.cloud.documentai.v1beta3.Processor] is specified, the
 server will use its [default
 version][google.cloud.documentai.v1beta3.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:
        This builder for chaining.

      • setNameBytes

        public ProcessRequest.Builder setNameBytes​(com.google.protobuf.ByteString value)
         Required. The resource name of the
 [Processor][google.cloud.documentai.v1beta3.Processor] or
 [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion]
 to use for processing. If a
 [Processor][google.cloud.documentai.v1beta3.Processor] is specified, the
 server will use its [default
 version][google.cloud.documentai.v1beta3.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) = { ... }
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • hasDocument

        @Deprecated
public boolean hasDocument()
        Deprecated.
        google.cloud.documentai.v1beta3.ProcessRequest.document is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=384
         The document payload, the
 [content][google.cloud.documentai.v1beta3.Document.content] and
 [mime_type][google.cloud.documentai.v1beta3.Document.mime_type] fields must
 be set.
        .google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];
        Specified by:
        hasDocument in interface ProcessRequestOrBuilder
        Returns:
        Whether the document field is set.

      • getDocument

        @Deprecated
public Document getDocument()
        Deprecated.
        google.cloud.documentai.v1beta3.ProcessRequest.document is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=384
         The document payload, the
 [content][google.cloud.documentai.v1beta3.Document.content] and
 [mime_type][google.cloud.documentai.v1beta3.Document.mime_type] fields must
 be set.
        .google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];
        Specified by:
        getDocument in interface ProcessRequestOrBuilder
        Returns:
        The document.

      • setDocument

        @Deprecated
public ProcessRequest.Builder setDocument​(Document value)
        Deprecated.
         The document payload, the
 [content][google.cloud.documentai.v1beta3.Document.content] and
 [mime_type][google.cloud.documentai.v1beta3.Document.mime_type] fields must
 be set.
        .google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];

      • setDocument

        @Deprecated
public ProcessRequest.Builder setDocument​(Document.Builder builderForValue)
        Deprecated.
         The document payload, the
 [content][google.cloud.documentai.v1beta3.Document.content] and
 [mime_type][google.cloud.documentai.v1beta3.Document.mime_type] fields must
 be set.
        .google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];

      • mergeDocument

        @Deprecated
public ProcessRequest.Builder mergeDocument​(Document value)
        Deprecated.
         The document payload, the
 [content][google.cloud.documentai.v1beta3.Document.content] and
 [mime_type][google.cloud.documentai.v1beta3.Document.mime_type] fields must
 be set.
        .google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];

      • clearDocument

        @Deprecated
public ProcessRequest.Builder clearDocument()
        Deprecated.
         The document payload, the
 [content][google.cloud.documentai.v1beta3.Document.content] and
 [mime_type][google.cloud.documentai.v1beta3.Document.mime_type] fields must
 be set.
        .google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];

      • getDocumentBuilder

        @Deprecated
public Document.Builder getDocumentBuilder()
        Deprecated.
         The document payload, the
 [content][google.cloud.documentai.v1beta3.Document.content] and
 [mime_type][google.cloud.documentai.v1beta3.Document.mime_type] fields must
 be set.
        .google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];

      • getDocumentOrBuilder

        @Deprecated
public DocumentOrBuilder getDocumentOrBuilder()
        Deprecated.
         The document payload, the
 [content][google.cloud.documentai.v1beta3.Document.content] and
 [mime_type][google.cloud.documentai.v1beta3.Document.mime_type] fields must
 be set.
        .google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];
        Specified by:
        getDocumentOrBuilder in interface ProcessRequestOrBuilder

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

      • setSkipHumanReview

        public ProcessRequest.Builder setSkipHumanReview​(boolean value)
         Whether human review should be skipped for this request. Default to
 `false`.
        bool skip_human_review = 3;
        Parameters:
        value - The skipHumanReview to set.
        Returns:
        This builder for chaining.

      • clearSkipHumanReview

        public ProcessRequest.Builder clearSkipHumanReview()
         Whether human review should be skipped for this request. Default to
 `false`.
        bool skip_human_review = 3;
        Returns:
        This builder for chaining.

      • hasFieldMask

        public boolean hasFieldMask()
         Specifies which fields to include in the
 [ProcessResponse.document][google.cloud.documentai.v1beta3.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.v1beta3.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.

      • setFieldMask

        public ProcessRequest.Builder setFieldMask​(com.google.protobuf.FieldMask value)
         Specifies which fields to include in the
 [ProcessResponse.document][google.cloud.documentai.v1beta3.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;

      • setFieldMask

        public ProcessRequest.Builder setFieldMask​(com.google.protobuf.FieldMask.Builder builderForValue)
         Specifies which fields to include in the
 [ProcessResponse.document][google.cloud.documentai.v1beta3.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;

      • mergeFieldMask

        public ProcessRequest.Builder mergeFieldMask​(com.google.protobuf.FieldMask value)
         Specifies which fields to include in the
 [ProcessResponse.document][google.cloud.documentai.v1beta3.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;

      • clearFieldMask

        public ProcessRequest.Builder clearFieldMask()
         Specifies which fields to include in the
 [ProcessResponse.document][google.cloud.documentai.v1beta3.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;

      • getFieldMaskBuilder

        public com.google.protobuf.FieldMask.Builder getFieldMaskBuilder()
         Specifies which fields to include in the
 [ProcessResponse.document][google.cloud.documentai.v1beta3.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;

      • getFieldMaskOrBuilder

        public com.google.protobuf.FieldMaskOrBuilder getFieldMaskOrBuilder()
         Specifies which fields to include in the
 [ProcessResponse.document][google.cloud.documentai.v1beta3.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.v1beta3.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.v1beta3.ProcessOptions process_options = 7;
        Specified by:
        getProcessOptions in interface ProcessRequestOrBuilder
        Returns:
        The processOptions.

      • setProcessOptions

        public ProcessRequest.Builder setProcessOptions​(ProcessOptions value)
         Inference-time options for the process API
        .google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;

      • setProcessOptions

        public ProcessRequest.Builder setProcessOptions​(ProcessOptions.Builder builderForValue)
         Inference-time options for the process API
        .google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;

      • mergeProcessOptions

        public ProcessRequest.Builder mergeProcessOptions​(ProcessOptions value)
         Inference-time options for the process API
        .google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;

      • clearProcessOptions

        public ProcessRequest.Builder clearProcessOptions()
         Inference-time options for the process API
        .google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;

      • getProcessOptionsBuilder

        public ProcessOptions.Builder getProcessOptionsBuilder()
         Inference-time options for the process API
        .google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;

      • setUnknownFields

        public final ProcessRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>

      • mergeUnknownFields

        public final ProcessRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessRequest.Builder>