Class BatchOperationMetadata (2.13.2)

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

Metadata used for long running operations returned by CTS batch APIs. It's used to replace google.longrunning.Operation.metadata][google.longrunning.Operation.metadata].

Attributes

NameDescription
state google.cloud.talent_v4.types.BatchOperationMetadata.State
The state of a long running operation.
state_description str
More detailed information about operation state.
success_count int
Count of successful item(s) inside an operation.
failure_count int
Count of failed item(s) inside an operation.
total_count int
Count of total item(s) inside an operation.
create_time google.protobuf.timestamp_pb2.Timestamp
The time when the batch operation is created.
update_time google.protobuf.timestamp_pb2.Timestamp
The time when the batch operation status is updated. The metadata and the update_time is refreshed every minute otherwise cached data is returned.
end_time google.protobuf.timestamp_pb2.Timestamp
The time when the batch operation is finished and google.longrunning.Operation.done][google.longrunning.Operation.done] is set to true.

Classes

State

State(value)

Values: STATE_UNSPECIFIED (0): Default value. INITIALIZING (1): The batch operation is being prepared for processing. PROCESSING (2): The batch operation is actively being processed. SUCCEEDED (3): The batch operation is processed, and at least one item has been successfully processed. FAILED (4): The batch operation is done and no item has been successfully processed. CANCELLING (5): The batch operation is in the process of cancelling after google.longrunning.Operations.CancelOperation][google.longrunning.Operations.CancelOperation] is called. CANCELLED (6): The batch operation is done after google.longrunning.Operations.CancelOperation][google.longrunning.Operations.CancelOperation] is called. Any items processed before cancelling are returned in the response.