Google Cloud Tasks V2beta2 Client - Class AcknowledgeTaskRequest (1.11.11)

Reference documentation and code samples for the Google Cloud Tasks V2beta2 Client class AcknowledgeTaskRequest.

Request message for acknowledging a task using AcknowledgeTask.

Generated from protobuf message google.cloud.tasks.v2beta2.AcknowledgeTaskRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

↳ schedule_time Google\Protobuf\Timestamp

Required. The task's current schedule time, available in the schedule_time returned by LeaseTasks response or RenewLease response. This restriction is to ensure that your worker currently holds the lease.

getName

Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

Returns
TypeDescription
string

setName

Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getScheduleTime

Required. The task's current schedule time, available in the schedule_time returned by LeaseTasks response or RenewLease response.

This restriction is to ensure that your worker currently holds the lease.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasScheduleTime

clearScheduleTime

setScheduleTime

Required. The task's current schedule time, available in the schedule_time returned by LeaseTasks response or RenewLease response.

This restriction is to ensure that your worker currently holds the lease.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this