Google Cloud Tasks V2beta3 Client - Class PullMessage (1.13.2)

Reference documentation and code samples for the Google Cloud Tasks V2beta3 Client class 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 and get , when the response view is FULL .

Generated from protobuf message google.cloud.tasks.v2beta3.PullMessage

Namespace

Google \ Cloud \ Tasks \ V2beta3

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ payload
string

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

↳ tag
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.

getPayload

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

Returns
Type
Description
string

setPayload

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getTag

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
Type
Description
string

setTag

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.

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: