Class PullMessage.Builder (2.83.0)

public static final class PullMessage.Builder extends GeneratedMessage.Builder<PullMessage.Builder> implements PullMessageOrBuilder

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.

Protobuf type google.cloud.tasks.v2beta3.PullMessage

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public PullMessage build()
Returns
Type Description
PullMessage

buildPartial()

public PullMessage buildPartial()
Returns
Type Description
PullMessage

clear()

public PullMessage.Builder clear()
Returns
Type Description
PullMessage.Builder
Overrides

clearPayload()

public PullMessage.Builder clearPayload()

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

bytes payload = 1;

Returns
Type Description
PullMessage.Builder

This builder for chaining.

clearTag()

public PullMessage.Builder clearTag()

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.

string tag = 2;

Returns
Type Description
PullMessage.Builder

This builder for chaining.

getDefaultInstanceForType()

public PullMessage getDefaultInstanceForType()
Returns
Type Description
PullMessage

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getPayload()

public ByteString getPayload()

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

bytes payload = 1;

Returns
Type Description
ByteString

The payload.

getTag()

public String 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.

string tag = 2;

Returns
Type Description
String

The tag.

getTagBytes()

public ByteString getTagBytes()

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.

string tag = 2;

Returns
Type Description
ByteString

The bytes for tag.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(PullMessage other)

public PullMessage.Builder mergeFrom(PullMessage other)
Parameter
Name Description
other PullMessage
Returns
Type Description
PullMessage.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PullMessage.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PullMessage.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PullMessage.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PullMessage.Builder
Overrides

setPayload(ByteString value)

public PullMessage.Builder setPayload(ByteString value)

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

bytes payload = 1;

Parameter
Name Description
value ByteString

The payload to set.

Returns
Type Description
PullMessage.Builder

This builder for chaining.

setTag(String value)

public PullMessage.Builder setTag(String value)

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.

string tag = 2;

Parameter
Name Description
value String

The tag to set.

Returns
Type Description
PullMessage.Builder

This builder for chaining.

setTagBytes(ByteString value)

public PullMessage.Builder setTagBytes(ByteString value)

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.

string tag = 2;

Parameter
Name Description
value ByteString

The bytes for tag to set.

Returns
Type Description
PullMessage.Builder

This builder for chaining.