Class: Google::Cloud::Tasks::V2beta2::RenewLeaseRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/cloudtasks.rb

Overview

Request message for renewing a lease using RenewLease.

Instance Attribute Summary collapse

Instance Attribute Details

#lease_duration ⇒ Google::Protobuf::Duration

Returns Required.

The desired new lease duration, starting from now.

The maximum lease duration is 1 week. +lease_duration+ will be truncated to the nearest second.

Returns:

  • (Google::Protobuf::Duration) —

    Required.

    The desired new lease duration, starting from now.

    The maximum lease duration is 1 week. +lease_duration+ will be truncated to the nearest second.



468
 
# File 'lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/cloudtasks.rb', line 468

class RenewLeaseRequest; end

#name ⇒ String

Returns Required.

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

Returns:

  • (String) —

    Required.

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



468
 
# File 'lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/cloudtasks.rb', line 468

class RenewLeaseRequest; end

#response_view ⇒ Google::Cloud::Tasks::V2beta2::Task::View

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.

Returns:

  • (Google::Cloud::Tasks::V2beta2::Task::View) —

    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.



468
 
# File 'lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/cloudtasks.rb', line 468

class RenewLeaseRequest; end

#schedule_time ⇒ Google::Protobuf::Timestamp

Returns 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:

  • (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.



468
 
# File 'lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/cloudtasks.rb', line 468

class RenewLeaseRequest; end