Class PullMessage.Builder (2.31.0)

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

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.

Protobuf type google.cloud.tasks.v2beta2.PullMessage

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PullMessage.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PullMessage.Builder
Overrides

build()

public PullMessage build()
Returns
TypeDescription
PullMessage

buildPartial()

public PullMessage buildPartial()
Returns
TypeDescription
PullMessage

clear()

public PullMessage.Builder clear()
Returns
TypeDescription
PullMessage.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public PullMessage.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
PullMessage.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public PullMessage.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
PullMessage.Builder
Overrides

clearPayload()

public PullMessage.Builder clearPayload()

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

bytes payload = 1;

Returns
TypeDescription
PullMessage.Builder

This builder for chaining.

clearTag()

public PullMessage.Builder clearTag()

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
PullMessage.Builder

This builder for chaining.

clone()

public PullMessage.Builder clone()
Returns
TypeDescription
PullMessage.Builder
Overrides

getDefaultInstanceForType()

public PullMessage getDefaultInstanceForType()
Returns
TypeDescription
PullMessage

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getPayload()

public ByteString getPayload()

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

bytes payload = 1;

Returns
TypeDescription
ByteString

The payload.

getTag()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(PullMessage other)

public PullMessage.Builder mergeFrom(PullMessage other)
Parameter
NameDescription
otherPullMessage
Returns
TypeDescription
PullMessage.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PullMessage.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PullMessage.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public PullMessage.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
PullMessage.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PullMessage.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PullMessage.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public PullMessage.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueByteString

The payload to set.

Returns
TypeDescription
PullMessage.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PullMessage.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
PullMessage.Builder
Overrides

setTag(String value)

public PullMessage.Builder setTag(String value)

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;

Parameter
NameDescription
valueString

The tag to set.

Returns
TypeDescription
PullMessage.Builder

This builder for chaining.

setTagBytes(ByteString value)

public PullMessage.Builder setTagBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for tag to set.

Returns
TypeDescription
PullMessage.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final PullMessage.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PullMessage.Builder
Overrides