Class: Google::Apis::CloudtasksV2beta2::PullMessage

Inherits:

Object

• Object
• Google::Apis::CloudtasksV2beta2::PullMessage

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

The pull message contains data that can be used by the caller of CloudTasks.LeaseTasks to process the task. This proto can only be used for tasks in a queue which has Queue.pull_target set.

Instance Attribute Summary

• #payload ⇒ String

  A data payload consumed by the worker to execute the task.

• #tag ⇒ String

  The task's tag.

Instance Method Summary

• #initialize(**args) ⇒ PullMessage constructor

  A new instance of PullMessage.

• #update!(**args) ⇒ Object

  Update properties of this object.

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

#to_json

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

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PullMessage

Returns a new instance of PullMessage

# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 877

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

Instance Attribute Details

#payload ⇒ String

A data payload consumed by the worker to execute the task. Corresponds to the JSON property payload NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

• (String)

# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 861

def payload
  @payload
end

#tag ⇒ String

The task's tag. Tags allow similar tasks to be processed in a batch. If you label tasks with a tag, your worker can lease tasks with the same tag using LeaseTasksRequest.filter. For example, if you want to aggregate the events associated with a specific user once a day, you could tag tasks with the user ID. The task's tag can only be set when the task is created. The tag must be less than 500 bytes. Corresponds to the JSON property tag NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

• (String)

# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 875

def tag
  @tag
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 882

def update!(**args)
  @payload = args[:payload] if args.key?(:payload)
  @tag = args[:tag] if args.key?(:tag)
end