Reference documentation and code samples for the Google Cloud Tasks V2beta2 Client class CancelLeaseRequest.
Request message for canceling a lease using CancelLease .
Generated from protobuf message google.cloud.tasks.v2beta2.CancelLeaseRequest
Methods
__construct
Constructor.
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.
↳ response_view
int
The response_view specifies which subset of the Task
will be returned. By default response_view is BASIC
; not all information is retrieved by default because some data, such as payloads, might be desirable to return only when needed because of its large size or because of the sensitivity of data that it contains. Authorization for FULL
requires cloudtasks.tasks.fullView
Google IAM
permission on the Task
resource.
getName
Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
string
setName
Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
var
string
$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.
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.
$this
getResponseView
The response_view specifies which subset of the Task will be returned.
By default response_view is BASIC
; not all information is
retrieved by default because some data, such as payloads, might be
desirable to return only when needed because of its large size or because
of the sensitivity of data that it contains.
Authorization for FULL
requires cloudtasks.tasks.fullView
Google
IAM
permission on the Task
resource.
int
setResponseView
The response_view specifies which subset of the Task will be returned.
By default response_view is BASIC
; not all information is
retrieved by default because some data, such as payloads, might be
desirable to return only when needed because of its large size or because
of the sensitivity of data that it contains.
Authorization for FULL
requires cloudtasks.tasks.fullView
Google
IAM
permission on the Task
resource.
var
int
$this
