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
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()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PullMessage.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public PullMessage build()
buildPartial()
public PullMessage buildPartial()
clear()
public PullMessage.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public PullMessage.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public PullMessage.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearPayload()
public PullMessage.Builder clearPayload()
A data payload consumed by the worker to execute the task.
bytes payload = 1;
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;
clone()
public PullMessage.Builder clone()
Overrides
getDefaultInstanceForType()
public PullMessage getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getPayload()
public ByteString getPayload()
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()
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 |
|---|
| Type | Description |
ByteString | The bytes for tag.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(PullMessage other)
public PullMessage.Builder mergeFrom(PullMessage other)
public PullMessage.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public PullMessage.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PullMessage.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public PullMessage.Builder setField(Descriptors.FieldDescriptor field, Object value)
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.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PullMessage.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
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 |
|---|
| Name | Description |
value | String
The tag to set.
|
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 |
|---|
| Name | Description |
value | ByteString
The bytes for tag to set.
|
setUnknownFields(UnknownFieldSet unknownFields)
public final PullMessage.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
