Class ProcessResponse (2.56.0)

public final class ProcessResponse extends GeneratedMessageV3 implements ProcessResponseOrBuilder

Response message for the ProcessDocument method.

Protobuf type google.cloud.documentai.v1beta3.ProcessResponse

Static Fields

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER
Field Value
Type Description
int

HUMAN_REVIEW_OPERATION_FIELD_NUMBER

public static final int HUMAN_REVIEW_OPERATION_FIELD_NUMBER
Field Value
Type Description
int

HUMAN_REVIEW_STATUS_FIELD_NUMBER

public static final int HUMAN_REVIEW_STATUS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ProcessResponse getDefaultInstance()
Returns
Type Description
ProcessResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ProcessResponse.Builder newBuilder()
Returns
Type Description
ProcessResponse.Builder

newBuilder(ProcessResponse prototype)

public static ProcessResponse.Builder newBuilder(ProcessResponse prototype)
Parameter
Name Description
prototype ProcessResponse
Returns
Type Description
ProcessResponse.Builder

parseDelimitedFrom(InputStream input)

public static ProcessResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ProcessResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProcessResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ProcessResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ProcessResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ProcessResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProcessResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ProcessResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ProcessResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ProcessResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProcessResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ProcessResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ProcessResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProcessResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ProcessResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ProcessResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProcessResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProcessResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ProcessResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ProcessResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ProcessResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProcessResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ProcessResponse> parser()
Returns
Type Description
Parser<ProcessResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ProcessResponse getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
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=529

The name of the operation triggered by the processed document. If the human review process isn't triggered, this field is empty. It has the same response type and metadata as the long-running operation returned by ReviewDocument.

string human_review_operation = 2 [deprecated = true];

Returns
Type Description
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=529

The name of the operation triggered by the processed document. If the human review process isn't triggered, this field is empty. It has the same response type and metadata as the long-running operation returned by ReviewDocument.

string human_review_operation = 2 [deprecated = true];

Returns
Type Description
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
Type Description
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
Type Description
HumanReviewStatusOrBuilder

getParserForType()

public Parser<ProcessResponse> getParserForType()
Returns
Type Description
Parser<ProcessResponse>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
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
Type Description
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
Type Description
boolean

Whether the humanReviewStatus field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ProcessResponse.Builder newBuilderForType()
Returns
Type Description
ProcessResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ProcessResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ProcessResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ProcessResponse.Builder toBuilder()
Returns
Type Description
ProcessResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException