Class ProcessResponse (2.12.0)

public final class ProcessResponse extends GeneratedMessageV3 implements ProcessResponseOrBuilder

Response message for the process document method.

Protobuf type google.cloud.documentai.v1beta3.ProcessResponse

Static Fields

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER
Field Value
TypeDescription
int

HUMAN_REVIEW_OPERATION_FIELD_NUMBER

public static final int HUMAN_REVIEW_OPERATION_FIELD_NUMBER
Field Value
TypeDescription
int

HUMAN_REVIEW_STATUS_FIELD_NUMBER

public static final int HUMAN_REVIEW_STATUS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ProcessResponse getDefaultInstance()
Returns
TypeDescription
ProcessResponse

getDescriptor()

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

newBuilder()

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

newBuilder(ProcessResponse prototype)

public static ProcessResponse.Builder newBuilder(ProcessResponse prototype)
Parameter
NameDescription
prototypeProcessResponse
Returns
TypeDescription
ProcessResponse.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ProcessResponse getDefaultInstanceForType()
Returns
TypeDescription
ProcessResponse

getDocument()

public Document getDocument()

The document payload, will populate fields based on the processor's behavior.

.google.cloud.documentai.v1beta3.Document document = 1;

Returns
TypeDescription
Document

The document.

getDocumentOrBuilder()

public DocumentOrBuilder getDocumentOrBuilder()

The document payload, will populate fields based on the processor's behavior.

.google.cloud.documentai.v1beta3.Document document = 1;

Returns
TypeDescription
DocumentOrBuilder

getHumanReviewOperation() (deprecated)

public String getHumanReviewOperation()

Deprecated. google.cloud.documentai.v1beta3.ProcessResponse.human_review_operation is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=412

The name of the operation triggered by the processed document. If the human review process is not triggered, this field will be empty. It has the same response type and metadata as the long running operation returned by ReviewDocument method.

string human_review_operation = 2 [deprecated = true];

Returns
TypeDescription
String

The humanReviewOperation.

getHumanReviewOperationBytes() (deprecated)

public ByteString getHumanReviewOperationBytes()

Deprecated. google.cloud.documentai.v1beta3.ProcessResponse.human_review_operation is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=412

The name of the operation triggered by the processed document. If the human review process is not triggered, this field will be empty. It has the same response type and metadata as the long running operation returned by ReviewDocument method.

string human_review_operation = 2 [deprecated = true];

Returns
TypeDescription
ByteString

The bytes for humanReviewOperation.

getHumanReviewStatus()

public HumanReviewStatus getHumanReviewStatus()

The status of human review on the processed document.

.google.cloud.documentai.v1beta3.HumanReviewStatus human_review_status = 3;

Returns
TypeDescription
HumanReviewStatus

The humanReviewStatus.

getHumanReviewStatusOrBuilder()

public HumanReviewStatusOrBuilder getHumanReviewStatusOrBuilder()

The status of human review on the processed document.

.google.cloud.documentai.v1beta3.HumanReviewStatus human_review_status = 3;

Returns
TypeDescription
HumanReviewStatusOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasDocument()

public boolean hasDocument()

The document payload, will populate fields based on the processor's behavior.

.google.cloud.documentai.v1beta3.Document document = 1;

Returns
TypeDescription
boolean

Whether the document field is set.

hasHumanReviewStatus()

public boolean hasHumanReviewStatus()

The status of human review on the processed document.

.google.cloud.documentai.v1beta3.HumanReviewStatus human_review_status = 3;

Returns
TypeDescription
boolean

Whether the humanReviewStatus 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 ProcessResponse.Builder newBuilderForType()
Returns
TypeDescription
ProcessResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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