Interface PullMessageOrBuilder (2.3.3) 

public interface PullMessageOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getPayload()

public abstract ByteString getPayload()

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

bytes payload = 1;

Returns
TypeDescription
ByteString

The payload.

getTag()

public abstract String getTag()

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.

string tag = 2;

Returns
TypeDescription
String

The tag.

getTagBytes()

public abstract ByteString getTagBytes()

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.

string tag = 2;

Returns
TypeDescription
ByteString

The bytes for tag.