Class PullMessage.Builder (2.14.0)

publicstaticfinalclass PullMessage.BuilderextendsGeneratedMessageV3.Builder<PullMessage.Builder>implementsPullMessageOrBuilder

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

Inherited Members

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

Static Methods

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

publicPullMessage.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PullMessage.Builder
Overrides

build()

publicPullMessagebuild()
Returns
Type Description
PullMessage

buildPartial()

publicPullMessagebuildPartial()
Returns
Type Description
PullMessage

clear()

publicPullMessage.Builderclear()
Returns
Type Description
PullMessage.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

publicPullMessage.BuilderclearField(Descriptors.FieldDescriptorfield)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PullMessage.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

publicPullMessage.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PullMessage.Builder
Overrides

clearPayload()

publicPullMessage.BuilderclearPayload()

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

bytes payload = 1;

Returns
Type Description
PullMessage.Builder

This builder for chaining.

clearTag()

publicPullMessage.BuilderclearTag()

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

This builder for chaining.

clone()

publicPullMessage.Builderclone()
Returns
Type Description
PullMessage.Builder
Overrides

getDefaultInstanceForType()

publicPullMessagegetDefaultInstanceForType()
Returns
Type Description
PullMessage

getDescriptorForType()

publicDescriptors.DescriptorgetDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getPayload()

publicByteStringgetPayload()

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

bytes payload = 1;

Returns
Type Description
ByteString

The payload.

getTag()

publicStringgetTag()

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

The tag.

getTagBytes()

publicByteStringgetTagBytes()

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

The bytes for tag.

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(PullMessage other)

publicPullMessage.BuildermergeFrom(PullMessageother)
Parameter
Name Description
other PullMessage
Returns
Type Description
PullMessage.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicPullMessage.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PullMessage.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

publicPullMessage.BuildermergeFrom(Messageother)
Parameter
Name Description
other Message
Returns
Type Description
PullMessage.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

publicfinalPullMessage.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PullMessage.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

publicPullMessage.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PullMessage.Builder
Overrides

setPayload(ByteString value)

publicPullMessage.BuildersetPayload(ByteStringvalue)

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.

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

publicPullMessage.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
PullMessage.Builder
Overrides

setTag(String value)

publicPullMessage.BuildersetTag(Stringvalue)

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
Name Description
value String

The tag to set.

Returns
Type Description
PullMessage.Builder

This builder for chaining.

setTagBytes(ByteString value)

publicPullMessage.BuildersetTagBytes(ByteStringvalue)

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
Name Description
value ByteString

The bytes for tag to set.

Returns
Type Description
PullMessage.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

publicfinalPullMessage.BuildersetUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PullMessage.Builder
Overrides

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.