Cloud Tasks V2beta2 API - Class Google::Cloud::Tasks::V2beta2::PullMessage (v0.9.2)

Reference documentation and code samples for the Cloud Tasks V2beta2 API class Google::Cloud::Tasks::V2beta2::PullMessage.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#payload

def payload() -> ::String
Returns
  • (::String) — A data payload consumed by the worker to execute the task.

#payload=

def payload=(value) -> ::String
Parameter
  • value (::String) — A data payload consumed by the worker to execute the task.
Returns
  • (::String) — A data payload consumed by the worker to execute the task.

#tag

def tag() -> ::String
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.

#tag=

def tag=(value) -> ::String
Parameter
  • value (::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.

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.