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()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
publicPullMessage.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
Overrides
build()
buildPartial()
publicPullMessagebuildPartial()
clear()
publicPullMessage.Builderclear()
Overrides
clearField(Descriptors.FieldDescriptor field)
publicPullMessage.BuilderclearField(Descriptors.FieldDescriptorfield)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
publicPullMessage.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
Overrides
clearPayload()
publicPullMessage.BuilderclearPayload()
A data payload consumed by the worker to execute the task.
bytes payload = 1;
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;
clone()
publicPullMessage.Builderclone()
Overrides
getDefaultInstanceForType()
publicPullMessagegetDefaultInstanceForType()
getDescriptorForType()
publicDescriptors.DescriptorgetDescriptorForType()
Overrides
getPayload()
publicByteStringgetPayload()
A data payload consumed by the worker to execute the task.
bytes payload = 1;
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 |
| 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()
Overrides
isInitialized()
publicfinalbooleanisInitialized()
Overrides
mergeFrom(PullMessage other)
publicPullMessage.BuildermergeFrom(PullMessageother)
publicPullMessage.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Overrides
mergeFrom(Message other)
publicPullMessage.BuildermergeFrom(Messageother)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
publicfinalPullMessage.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
publicPullMessage.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
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.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
publicPullMessage.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
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.
|
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.
|
setUnknownFields(UnknownFieldSet unknownFields)
publicfinalPullMessage.BuildersetUnknownFields(UnknownFieldSetunknownFields)
Overrides