Google Cloud Tasks V2 Client - Class BatchDeleteTasksMetadata (2.3.0)

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

Metadata for the long-running operation returned by BatchDeleteTasks.

This message is used to hold metadata information about the batch delete tasks operation; that is, it is put in google.longrunning.Operation.metadata.

Generated from protobuf message google.cloud.tasks.v2.BatchDeleteTasksMetadata

Namespace

Google \ Cloud \ Tasks \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ start_time Google\Protobuf\Timestamp

Output only. The time when the batch delete started.

↳ end_time Google\Protobuf\Timestamp

Output only. The time when the batch delete finished.

↳ state int

Output only. The state of the batch delete operation.

↳ failed_requests array|Google\Protobuf\Internal\MapField

Output only. A map of failed requests, where the key is the index of the request in BatchDeleteTasksRequest.names and the value is the error status.

getStartTime

Output only. The time when the batch delete started.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Output only. The time when the batch delete started.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getEndTime

Output only. The time when the batch delete finished.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

Output only. The time when the batch delete finished.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getState

Output only. The state of the batch delete operation.

Returns
Type Description
int Enum of type State.

setState

Output only. The state of the batch delete operation.

Parameter
Name Description
var int

Enum of type State.

Returns
Type Description
$this

getFailedRequests

Output only. A map of failed requests, where the key is the index of the request in BatchDeleteTasksRequest.names and the value is the error status.

Returns
Type Description
Google\Protobuf\Internal\MapField

setFailedRequests

Output only. A map of failed requests, where the key is the index of the request in BatchDeleteTasksRequest.names and the value is the error status.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this