Class: Google::Cloud::Tasks::V2beta2::PullMessage

Inherits:

Object

• Object
• Google::Cloud::Tasks::V2beta2::PullMessage

Defined in:

lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/target.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

• #payload ⇒ String

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

• #tag ⇒ String

  The task's tag.

Instance Attribute Details

#payload ⇒ String

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

Returns:

• (String) —

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

# File 'lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/target.rb', line 50

class PullMessage; end

#tag ⇒ String

Returns 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.

Returns:

• (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.

# File 'lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/target.rb', line 50

class PullMessage; end