public final class ProcessRequest extends GeneratedMessageV3 implements ProcessRequestOrBuilder
Request message for the process document method.
Protobuf type google.cloud.documentai.v1beta3.ProcessRequest
Static Fields
DOCUMENT_FIELD_NUMBER
public static final int DOCUMENT_FIELD_NUMBER
Field Value
FIELD_MASK_FIELD_NUMBER
public static final int FIELD_MASK_FIELD_NUMBER
Field Value
INLINE_DOCUMENT_FIELD_NUMBER
public static final int INLINE_DOCUMENT_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
PROCESS_OPTIONS_FIELD_NUMBER
public static final int PROCESS_OPTIONS_FIELD_NUMBER
Field Value
RAW_DOCUMENT_FIELD_NUMBER
public static final int RAW_DOCUMENT_FIELD_NUMBER
Field Value
SKIP_HUMAN_REVIEW_FIELD_NUMBER
public static final int SKIP_HUMAN_REVIEW_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ProcessRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ProcessRequest.Builder newBuilder()
Returns
newBuilder(ProcessRequest prototype)
public static ProcessRequest.Builder newBuilder(ProcessRequest prototype)
Parameter
Returns
public static ProcessRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ProcessRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ProcessRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ProcessRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ProcessRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ProcessRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ProcessRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ProcessRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ProcessRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ProcessRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ProcessRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ProcessRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ProcessRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public ProcessRequest getDefaultInstanceForType()
Returns
getDocument() (deprecated)
public Document getDocument()
Deprecated. google.cloud.documentai.v1beta3.ProcessRequest.document is deprecated. See
google/cloud/documentai/v1beta3/document_processor_service.proto;l=351
The document payload, the [content] and [mime_type] fields must be set.
.google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];
getDocumentOrBuilder()
public DocumentOrBuilder getDocumentOrBuilder()
The document payload, the [content] and [mime_type] fields must be set.
.google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];
getFieldMask()
public FieldMask getFieldMask()
Specifies which fields to include in ProcessResponse's document.
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 FieldMaskOrBuilder getFieldMaskOrBuilder()
Specifies which fields to include in ProcessResponse's document.
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;
getInlineDocument()
public Document getInlineDocument()
An inline document proto.
.google.cloud.documentai.v1beta3.Document inline_document = 4;
| Type | Description |
| Document | The inlineDocument.
|
getInlineDocumentOrBuilder()
public DocumentOrBuilder getInlineDocumentOrBuilder()
An inline document proto.
.google.cloud.documentai.v1beta3.Document inline_document = 4;
getName()
Required. The resource name of the
Processor or
ProcessorVersion
to use for processing. If a
Processor is specified, the
server will use its default
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) = { ... }
| Type | Description |
| String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Required. The resource name of the
Processor or
ProcessorVersion
to use for processing. If a
Processor is specified, the
server will use its default
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) = { ... }
getParserForType()
public Parser<ProcessRequest> getParserForType()
Returns
Overrides
getProcessOptions()
public ProcessOptions getProcessOptions()
Inference-time options for the process API
.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;
getProcessOptionsOrBuilder()
public ProcessOptionsOrBuilder getProcessOptionsOrBuilder()
Inference-time options for the process API
.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;
getRawDocument()
public RawDocument getRawDocument()
A raw document content (bytes).
.google.cloud.documentai.v1beta3.RawDocument raw_document = 5;
getRawDocumentOrBuilder()
public RawDocumentOrBuilder getRawDocumentOrBuilder()
A raw document content (bytes).
.google.cloud.documentai.v1beta3.RawDocument raw_document = 5;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSkipHumanReview()
public boolean getSkipHumanReview()
Whether Human Review feature should be skipped for this request. Default to
false.
bool skip_human_review = 3;
| Type | Description |
| boolean | The skipHumanReview.
|
getSourceCase()
public ProcessRequest.SourceCase getSourceCase()
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasDocument() (deprecated)
public boolean hasDocument()
Deprecated. google.cloud.documentai.v1beta3.ProcessRequest.document is deprecated. See
google/cloud/documentai/v1beta3/document_processor_service.proto;l=351
The document payload, the [content] and [mime_type] fields must be set.
.google.cloud.documentai.v1beta3.Document document = 2 [deprecated = true];
| Type | Description |
| boolean | Whether the document field is set.
|
hasFieldMask()
public boolean hasFieldMask()
Specifies which fields to include in ProcessResponse's document.
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;
| Type | Description |
| boolean | Whether the fieldMask field is set.
|
hasInlineDocument()
public boolean hasInlineDocument()
An inline document proto.
.google.cloud.documentai.v1beta3.Document inline_document = 4;
| Type | Description |
| boolean | Whether the inlineDocument field is set.
|
hasProcessOptions()
public boolean hasProcessOptions()
Inference-time options for the process API
.google.cloud.documentai.v1beta3.ProcessOptions process_options = 7;
| Type | Description |
| boolean | Whether the processOptions field is set.
|
hasRawDocument()
public boolean hasRawDocument()
A raw document content (bytes).
.google.cloud.documentai.v1beta3.RawDocument raw_document = 5;
| Type | Description |
| boolean | Whether the rawDocument field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ProcessRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ProcessRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ProcessRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
