Class: Google::Apis::CloudtasksV2beta2::PullTasksRequest

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 pulling tasks using CloudTasks.PullTasks.

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) ⇒ PullTasksRequest

Returns a new instance of PullTasksRequest



987
988
989
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 987

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 PullTasksResponse will contain only tasks whose PullMessage.tag is equal to <my-tag>. <my-tag> must be less than 500 bytes. 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 | bytes
  • function = "oldest_tag()" The oldest_tag() function returns tasks which have the same tag as the oldest task (ordered by schedule time). Corresponds to the JSON property filter

Returns:

  • (String) 


945
946
947
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 945

def filter
  @filter
end

#lease_duration ⇒ String

The duration of the lease. Each task returned in the PullTasksResponse will have its Task.schedule_time set to the current time plus the lease_duration. A task that has been returned in a PullTasksResponse is leased -- that task will not be returned in a different PullTasksResponse before the Task.schedule_time. After the lease holder has successfully finished the work associated with the task, the lease holder must call CloudTasks.AcknowledgeTask. If the task is not acknowledged via CloudTasks.AcknowledgeTask before the Task.schedule_time then it will be returned in a later PullTasksResponse so that another lease holder can process 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) 


965
966
967
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 965

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) 


971
972
973
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 971

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 Task.View.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 Task.View.FULL requires cloudtasks.tasks.fullView Google IAM permission on the Task.name resource. Corresponds to the JSON property responseView

Returns:

  • (String) 


985
986
987
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 985

def response_view
  @response_view
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



992
993
994
995
996
997
 
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 992

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