Google Cloud Tasks V2 Client - Class State (2.3.0)

Reference documentation and code samples for the Google Cloud Tasks V2 Client class State.

The state of the batch delete operation.

This enum is not frozen and new values may be added in the future.

Protobuf type google.cloud.tasks.v2.BatchDeleteTasksMetadata.State

Namespace

Google \ Cloud \ Tasks \ V2 \ BatchDeleteTasksMetadata

Methods

static::name

Parameter
Name Description
value mixed

static::value

Parameter
Name Description
name mixed

Constants

STATE_UNSPECIFIED

Value: 0

The default value. This value is used if the state is omitted.

Generated from protobuf enum STATE_UNSPECIFIED = 0;

RUNNING

Value: 1

The batch delete is running.

Generated from protobuf enum RUNNING = 1;

SUCCEEDED

Value: 2

The batch delete has finished and all tasks were successfully deleted.

Generated from protobuf enum SUCCEEDED = 2;

PARTIALLY_SUCCEEDED

Value: 3

The batch delete has finished with partial success.

The tasks that failed to be deleted are reported in failed_requests. When all requests in the batch fail, google.longrunning.Operation.error will be set with code = google.rpc.Code.ABORTED and message = "None of the requests succeeded, refer to BatchDeleteTasksMetadata.failed_requests for individual error details".

Generated from protobuf enum PARTIALLY_SUCCEEDED = 3;

FAILED

Value: 4

The batch delete has failed.

This means the overall batch delete operation failed to complete. This can happen due to an internal error preventing the operation from finishing.

Generated from protobuf enum FAILED = 4;