Class BatchProcessMetadata (2.19.0)

BatchProcessMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The long-running operation metadata for BatchProcessDocuments.

Attributes

NameDescription
state google.cloud.documentai_v1.types.BatchProcessMetadata.State
The state of the current batch processing.
state_message str
A message providing more details about the current state of processing. For example, the error message if the operation is failed.
create_time google.protobuf.timestamp_pb2.Timestamp
The creation time of the operation.
update_time google.protobuf.timestamp_pb2.Timestamp
The last update time of the operation.
individual_process_statuses MutableSequence[google.cloud.documentai_v1.types.BatchProcessMetadata.IndividualProcessStatus]
The list of response details of each document.

Classes

IndividualProcessStatus

IndividualProcessStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

State

State(value)

Possible states of the batch processing operation.

Values: STATE_UNSPECIFIED (0): The default value. This value is used if the state is omitted. WAITING (1): Request operation is waiting for scheduling. RUNNING (2): Request is being processed. SUCCEEDED (3): The batch processing completed successfully. CANCELLING (4): The batch processing was being cancelled. CANCELLED (5): The batch processing was cancelled. FAILED (6): The batch processing has failed.