Class BatchProcessMetadata (2.17.0)

Version 2.17.0

• 3.1.0 (latest)
• 3.0.1
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.3
• 2.28.0
• 2.27.1
• 2.26.0
• 2.25.0
• 2.24.2
• 2.23.0
• 2.22.0
• 2.21.1
• 2.20.2
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.1
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.1
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.3
• 1.5.1
• 1.4.2
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.0
• 0.5.2
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

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

The long-running operation metadata for BatchProcessDocuments.

Attributes
Name	Description
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.