Class ProcessRequest (2.20.0)

public final class ProcessRequest extends GeneratedMessageV3 implements ProcessRequestOrBuilder

Request message for the process document method.

Protobuf type google.cloud.documentai.v1.ProcessRequest

Static Fields

FIELD_MASK_FIELD_NUMBER

public static final int FIELD_MASK_FIELD_NUMBER
Field Value
TypeDescription
int

INLINE_DOCUMENT_FIELD_NUMBER

public static final int INLINE_DOCUMENT_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

RAW_DOCUMENT_FIELD_NUMBER

public static final int RAW_DOCUMENT_FIELD_NUMBER
Field Value
TypeDescription
int

SKIP_HUMAN_REVIEW_FIELD_NUMBER

public static final int SKIP_HUMAN_REVIEW_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ProcessRequest getDefaultInstance()
Returns
TypeDescription
ProcessRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ProcessRequest.Builder newBuilder()
Returns
TypeDescription
ProcessRequest.Builder

newBuilder(ProcessRequest prototype)

public static ProcessRequest.Builder newBuilder(ProcessRequest prototype)
Parameter
NameDescription
prototypeProcessRequest
Returns
TypeDescription
ProcessRequest.Builder

parseDelimitedFrom(InputStream input)

public static ProcessRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ProcessRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ProcessRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ProcessRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ProcessRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ProcessRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ProcessRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ProcessRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ProcessRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ProcessRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ProcessRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ProcessRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ProcessRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ProcessRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ProcessRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProcessRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ProcessRequest> parser()
Returns
TypeDescription
Parser<ProcessRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ProcessRequest getDefaultInstanceForType()
Returns
TypeDescription
ProcessRequest

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;

Returns
TypeDescription
FieldMask

The fieldMask.

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;

Returns
TypeDescription
FieldMaskOrBuilder

getInlineDocument()

public Document getInlineDocument()

An inline document proto.

.google.cloud.documentai.v1.Document inline_document = 4;

Returns
TypeDescription
Document

The inlineDocument.

getInlineDocumentOrBuilder()

public DocumentOrBuilder getInlineDocumentOrBuilder()

An inline document proto.

.google.cloud.documentai.v1.Document inline_document = 4;

Returns
TypeDescription
DocumentOrBuilder

getName()

public String 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) = { ... }

Returns
TypeDescription
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) = { ... }

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<ProcessRequest> getParserForType()
Returns
TypeDescription
Parser<ProcessRequest>
Overrides

getRawDocument()

public RawDocument getRawDocument()

A raw document content (bytes).

.google.cloud.documentai.v1.RawDocument raw_document = 5;

Returns
TypeDescription
RawDocument

The rawDocument.

getRawDocumentOrBuilder()

public RawDocumentOrBuilder getRawDocumentOrBuilder()

A raw document content (bytes).

.google.cloud.documentai.v1.RawDocument raw_document = 5;

Returns
TypeDescription
RawDocumentOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSkipHumanReview()

public boolean getSkipHumanReview()

Whether Human Review feature should be skipped for this request. Default to false.

bool skip_human_review = 3;

Returns
TypeDescription
boolean

The skipHumanReview.

getSourceCase()

public ProcessRequest.SourceCase getSourceCase()
Returns
TypeDescription
ProcessRequest.SourceCase

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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;

Returns
TypeDescription
boolean

Whether the fieldMask field is set.

hasInlineDocument()

public boolean hasInlineDocument()

An inline document proto.

.google.cloud.documentai.v1.Document inline_document = 4;

Returns
TypeDescription
boolean

Whether the inlineDocument field is set.

hasRawDocument()

public boolean hasRawDocument()

A raw document content (bytes).

.google.cloud.documentai.v1.RawDocument raw_document = 5;

Returns
TypeDescription
boolean

Whether the rawDocument field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ProcessRequest.Builder newBuilderForType()
Returns
TypeDescription
ProcessRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ProcessRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ProcessRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ProcessRequest.Builder toBuilder()
Returns
TypeDescription
ProcessRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException