Google Cloud Tasks V2 Client - Class Attempt (1.14.5)

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

The status of a task attempt.

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

Namespace

Google \ Cloud \ Tasks \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ schedule_time Google\Protobuf\Timestamp

Output only. The time that this attempt was scheduled. schedule_time will be truncated to the nearest microsecond.

↳ dispatch_time Google\Protobuf\Timestamp

Output only. The time that this attempt was dispatched. dispatch_time will be truncated to the nearest microsecond.

↳ response_time Google\Protobuf\Timestamp

Output only. The time that this attempt response was received. response_time will be truncated to the nearest microsecond.

↳ response_status Google\Rpc\Status

Output only. The response from the worker for this attempt. If response_time is unset, then the task has not been attempted or is currently running and the response_status field is meaningless.

getScheduleTime

Output only. The time that this attempt was scheduled.

schedule_time will be truncated to the nearest microsecond.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasScheduleTime

clearScheduleTime

setScheduleTime

Output only. The time that this attempt was scheduled.

schedule_time will be truncated to the nearest microsecond.

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

getDispatchTime

Output only. The time that this attempt was dispatched.

dispatch_time will be truncated to the nearest microsecond.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasDispatchTime

clearDispatchTime

setDispatchTime

Output only. The time that this attempt was dispatched.

dispatch_time will be truncated to the nearest microsecond.

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

getResponseTime

Output only. The time that this attempt response was received.

response_time will be truncated to the nearest microsecond.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasResponseTime

clearResponseTime

setResponseTime

Output only. The time that this attempt response was received.

response_time will be truncated to the nearest microsecond.

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

getResponseStatus

Output only. The response from the worker for this attempt.

If response_time is unset, then the task has not been attempted or is currently running and the response_status field is meaningless.

Returns
Type Description
Google\Rpc\Status|null

hasResponseStatus

clearResponseStatus

setResponseStatus

Output only. The response from the worker for this attempt.

If response_time is unset, then the task has not been attempted or is currently running and the response_status field is meaningless.

Parameter
Name Description
var Google\Rpc\Status
Returns
Type Description
$this