Class BatchProcessMetadata.IndividualProcessStatus (2.8.0)

public static final class BatchProcessMetadata.IndividualProcessStatus extends GeneratedMessageV3 implements BatchProcessMetadata.IndividualProcessStatusOrBuilder

The status of a each individual document in the batch process.

Protobuf type google.cloud.documentai.v1beta3.BatchProcessMetadata.IndividualProcessStatus

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BatchProcessMetadata.IndividualProcessStatus

Static Fields

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

INPUT_GCS_SOURCE_FIELD_NUMBER

public static final int INPUT_GCS_SOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

OUTPUT_GCS_DESTINATION_FIELD_NUMBER

public static final int OUTPUT_GCS_DESTINATION_FIELD_NUMBER
Field Value
TypeDescription
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BatchProcessMetadata.IndividualProcessStatus getDefaultInstance()
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus

getDescriptor()

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

newBuilder()

public static BatchProcessMetadata.IndividualProcessStatus.Builder newBuilder()
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder

newBuilder(BatchProcessMetadata.IndividualProcessStatus prototype)

public static BatchProcessMetadata.IndividualProcessStatus.Builder newBuilder(BatchProcessMetadata.IndividualProcessStatus prototype)
Parameter
NameDescription
prototypeBatchProcessMetadata.IndividualProcessStatus
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder

parseDelimitedFrom(InputStream input)

public static BatchProcessMetadata.IndividualProcessStatus parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static BatchProcessMetadata.IndividualProcessStatus parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static BatchProcessMetadata.IndividualProcessStatus parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static BatchProcessMetadata.IndividualProcessStatus parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static BatchProcessMetadata.IndividualProcessStatus parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<BatchProcessMetadata.IndividualProcessStatus> parser()
Returns
TypeDescription
Parser<IndividualProcessStatus>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public BatchProcessMetadata.IndividualProcessStatus getDefaultInstanceForType()
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus

getHumanReviewOperation() (deprecated)

public String getHumanReviewOperation()

Deprecated. google.cloud.documentai.v1beta3.BatchProcessMetadata.IndividualProcessStatus.human_review_operation is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=417

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 = 4 [deprecated = true];

Returns
TypeDescription
String

The humanReviewOperation.

getHumanReviewOperationBytes() (deprecated)

public ByteString getHumanReviewOperationBytes()

Deprecated. google.cloud.documentai.v1beta3.BatchProcessMetadata.IndividualProcessStatus.human_review_operation is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=417

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 = 4 [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 = 5;

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 = 5;

Returns
TypeDescription
HumanReviewStatusOrBuilder

getInputGcsSource()

public String getInputGcsSource()

The source of the document, same as the [input_gcs_source] field in the request when the batch process started. The batch process is started by take snapshot of that document, since a user can move or change that document during the process.

string input_gcs_source = 1;

Returns
TypeDescription
String

The inputGcsSource.

getInputGcsSourceBytes()

public ByteString getInputGcsSourceBytes()

The source of the document, same as the [input_gcs_source] field in the request when the batch process started. The batch process is started by take snapshot of that document, since a user can move or change that document during the process.

string input_gcs_source = 1;

Returns
TypeDescription
ByteString

The bytes for inputGcsSource.

getOutputGcsDestination()

public String getOutputGcsDestination()

The output_gcs_destination (in the request as output_gcs_destination) of the processed document if it was successful, otherwise empty.

string output_gcs_destination = 3;

Returns
TypeDescription
String

The outputGcsDestination.

getOutputGcsDestinationBytes()

public ByteString getOutputGcsDestinationBytes()

The output_gcs_destination (in the request as output_gcs_destination) of the processed document if it was successful, otherwise empty.

string output_gcs_destination = 3;

Returns
TypeDescription
ByteString

The bytes for outputGcsDestination.

getParserForType()

public Parser<BatchProcessMetadata.IndividualProcessStatus> getParserForType()
Returns
TypeDescription
Parser<IndividualProcessStatus>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStatus()

public Status getStatus()

The status processing the document.

.google.rpc.Status status = 2;

Returns
TypeDescription
com.google.rpc.Status

The status.

getStatusOrBuilder()

public StatusOrBuilder getStatusOrBuilder()

The status processing the document.

.google.rpc.Status status = 2;

Returns
TypeDescription
com.google.rpc.StatusOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasHumanReviewStatus()

public boolean hasHumanReviewStatus()

The status of human review on the processed document.

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

Returns
TypeDescription
boolean

Whether the humanReviewStatus field is set.

hasStatus()

public boolean hasStatus()

The status processing the document.

.google.rpc.Status status = 2;

Returns
TypeDescription
boolean

Whether the status 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 BatchProcessMetadata.IndividualProcessStatus.Builder newBuilderForType()
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public BatchProcessMetadata.IndividualProcessStatus.Builder toBuilder()
Returns
TypeDescription
BatchProcessMetadata.IndividualProcessStatus.Builder

writeTo(CodedOutputStream output)

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