- 2.52.0 (latest)
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.12
- 2.2.0
- 2.1.11
public static final class PullMessage.Builder extends GeneratedMessageV3.Builder<PullMessage.Builder> implements PullMessageOrBuilderThe 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PullMessage.BuilderImplements
PullMessageOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PullMessage.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
PullMessage.Builder | |
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 | |
clearField(Descriptors.FieldDescriptor field)
public PullMessage.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
PullMessage.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public PullMessage.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
PullMessage.Builder | |
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 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()
public PullMessage.Builder clone()| Returns | |
|---|---|
| Type | Description |
PullMessage.Builder | |
getDefaultInstanceForType()
public PullMessage getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
PullMessage | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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 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()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
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 | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public PullMessage.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
PullMessage.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PullMessage.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PullMessage.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public PullMessage.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
PullMessage.Builder | |
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 | ByteStringThe payload to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
PullMessage.Builder | |
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 | StringThe tag to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for tag to set. |
| Returns | |
|---|---|
| Type | Description |
PullMessage.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final PullMessage.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
PullMessage.Builder | |