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

Inherits:

Object

• Object
• Google::Apis::CloudtasksV2beta2::LeaseTasksRequest

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 leasing tasks using LeaseTasks.

Instance Attribute Summary

• #filter ⇒ String

  filter can be used to specify a subset of tasks to lease.

• #lease_duration ⇒ String

  Required.

• #max_tasks ⇒ Fixnum

  The maximum number of tasks to lease.

• #response_view ⇒ String

  The response_view specifies which subset of the Task will be returned.

Instance Method Summary

• #initialize(**args) ⇒ LeaseTasksRequest constructor

  A new instance of LeaseTasksRequest.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ LeaseTasksRequest

Returns a new instance of LeaseTasksRequest.

# File 'lib/google/apis/cloudtasks_v2beta2/classes.rb', line 989

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= then the response will contain only tasks whose tag is equal to . `must be less than 500 characters. Whenfilteris set totag_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](https://cloud.google.com/appengine/docs/ standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag- byte:A-), 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 propertyfilter`

Returns:

• (String)

# File 'lib/google/apis/cloudtasks_v2beta2/classes.rb', line 955

def filter
  @filter
end

#lease_duration ⇒ String

Required. The duration of the lease. Each task returned in the response will have its schedule_time set to the current time plus the lease_duration. The task is leased until its schedule_time; thus, the task will not be returned to another LeaseTasks call before its schedule_time. 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)

# File 'lib/google/apis/cloudtasks_v2beta2/classes.rb', line 968

def lease_duration
  @lease_duration
end

#max_tasks ⇒ Fixnum

The maximum number of tasks to lease. The system will make a best effort to return as close to as max_tasks as possible. The largest that max_tasks can be is 1000. The maximum total size of a lease tasks response is 32 MB. If the sum of all task sizes requested reaches this limit, fewer tasks than requested are returned. Corresponds to the JSON property maxTasks

Returns:

• (Fixnum)

# File 'lib/google/apis/cloudtasks_v2beta2/classes.rb', line 977

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)

# File 'lib/google/apis/cloudtasks_v2beta2/classes.rb', line 987

def response_view
  @response_view
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/cloudtasks_v2beta2/classes.rb', line 994

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