Class: Google::Apis::CloudtasksV2beta2::RenewLeaseRequest

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudtasks_v2beta2/classes.rb,
lib/google/apis/cloudtasks_v2beta2/representations.rb,
lib/google/apis/cloudtasks_v2beta2/representations.rb

Overview

Request message for renewing a lease using RenewLease.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RenewLeaseRequest

Returns a new instance of RenewLeaseRequest.



1809
1810
1811
 
# File 'lib/google/apis/cloudtasks_v2beta2/classes.rb', line 1809

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#lease_duration ⇒ String

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. Corresponds to the JSON property leaseDuration

Returns:

  • (String) 


1790
1791
1792
 
# File 'lib/google/apis/cloudtasks_v2beta2/classes.rb', line 1790

def lease_duration
  @lease_duration
end

#response_view ⇒ String

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. Corresponds to the JSON property responseView

Returns:

  • (String) 


1800
1801
1802
 
# File 'lib/google/apis/cloudtasks_v2beta2/classes.rb', line 1800

def response_view
  @response_view
end

#schedule_time ⇒ String

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. Corresponds to the JSON property scheduleTime

Returns:

  • (String) 


1807
1808
1809
 
# File 'lib/google/apis/cloudtasks_v2beta2/classes.rb', line 1807

def schedule_time
  @schedule_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1814
1815
1816
1817
1818
 
# File 'lib/google/apis/cloudtasks_v2beta2/classes.rb', line 1814

def update!(**args)
  @lease_duration = args[:lease_duration] if args.key?(:lease_duration)
  @response_view = args[:response_view] if args.key?(:response_view)
  @schedule_time = args[:schedule_time] if args.key?(:schedule_time)
end