Class: Google::Apis::CloudtasksV2beta2::LeaseTasksRequest

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

Overview

Request message for leasing tasks using LeaseTasks.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ LeaseTasksRequest

Returns a new instance of LeaseTasksRequest



635
636
637
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 635

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

Instance Attribute Details

#filter ⇒ String

filter can be used to specify a subset of tasks to lease. When filter is set to tag=<my-tag> then the response will contain only tasks whose tag is equal to <my-tag>. <my-tag> must be less than 500 characters. When filter is set to tag_function=oldest_tag(), only tasks which have the same tag as the task with the oldest schedule_time will be returned. Grammar Syntax:

  • filter = "tag=" tag | "tag_function=" function
  • tag = string
  • function = "oldest_tag()" The oldest_tag() function returns tasks which have the same tag as the oldest task (ordered by schedule time). SDK compatibility: Although the SDK allows tags to be either string or bytes, only UTF-8 encoded tags can be used in Cloud Tasks. Tag which aren't UTF-8 encoded can't be used in the filter and the task's tag will be displayed as empty in Cloud Tasks. Corresponds to the JSON property filter

Returns:

  • (String) 


601
602
603
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 601

def filter
  @filter
end

#lease_duration ⇒ String

After the worker has successfully finished the work associated with the task, the worker must call via AcknowledgeTask before the schedule_time. Otherwise the task will be returned to a later LeaseTasks call so that another worker can retry it. The maximum lease duration is 1 week. lease_duration will be truncated to the nearest second. Corresponds to the JSON property leaseDuration

Returns:

  • (String) 


613
614
615
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 613

def lease_duration
  @lease_duration
end

#max_tasks ⇒ Fixnum

The maximum number of tasks to lease. The maximum that can be requested is 1000. Corresponds to the JSON property maxTasks

Returns:

  • (Fixnum) 


619
620
621
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 619

def max_tasks
  @max_tasks
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) 


633
634
635
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 633

def response_view
  @response_view
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



640
641
642
643
644
645
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 640

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