Class: Google::Apis::CloudtasksV2beta2::PullMessage
- Inherits:
-
Object
- Object
- Google::Apis::CloudtasksV2beta2::PullMessage
- 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 LeaseTasks to process the task. This proto can only be used for tasks in a queue which has pull_target set.
Instance Attribute Summary collapse
-
#payload ⇒ String
A data payload consumed by the worker to execute the task.
-
#tag ⇒ String
The task's tag.
Instance Method Summary collapse
-
#initialize(**args) ⇒ PullMessage
constructor
A new instance of PullMessage.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ PullMessage
Returns a new instance of PullMessage
908 909 910 |
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 908 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.
887 888 889 |
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 887 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
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 characters.
SDK compatibility: Although the SDK allows tags to be either
string or bytes,
only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
encoded, the tag will be empty when the task is returned by Cloud Tasks.
Corresponds to the JSON property tag
906 907 908 |
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 906 def tag @tag end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
913 914 915 916 |
# File 'generated/google/apis/cloudtasks_v2beta2/classes.rb', line 913 def update!(**args) @payload = args[:payload] if args.key?(:payload) @tag = args[:tag] if args.key?(:tag) end |