Cloud Tasks V2beta3 API - Class Google::Cloud::Tasks::V2beta3::PullMessage (v0.9.0)

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

Pull Message.

This proto can only be used for tasks in a queue which has PULL type. It currently exists for backwards compatibility with the App Engine Task Queue SDK. This message type maybe returned with methods [list][google.cloud.tasks.v2beta3.CloudTask.ListTasks] and [get][google.cloud.tasks.v2beta3.CloudTask.ListTasks], when the response view is [FULL][google.cloud.tasks.v2beta3.Task.View.Full].

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 tasks's tag.

    The tag is 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 tasks's tag.

    The tag is 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 tasks's tag.

    The tag is 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.