Class PullMessage (2.30.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.80.0 (latest)
- 2.78.0
- 2.76.0
- 2.75.0
- 2.74.0
- 2.73.0
- 2.72.0
- 2.70.0
- 2.68.0
- 2.67.0
- 2.64.0
- 2.63.0
- 2.62.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.52.0
- 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
publicfinalclass PullMessageextendsGeneratedMessageV3implementsPullMessageOrBuilderThe 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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PullMessageImplements
PullMessageOrBuilderInherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
Static Fields
PAYLOAD_FIELD_NUMBER
publicstaticfinalintPAYLOAD_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TAG_FIELD_NUMBER
publicstaticfinalintTAG_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
publicstaticPullMessagegetDefaultInstance()| Returns | |
|---|---|
| Type | Description |
PullMessage |
|
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
publicstaticPullMessage.BuildernewBuilder()| Returns | |
|---|---|
| Type | Description |
PullMessage.Builder |
|
newBuilder(PullMessage prototype)
publicstaticPullMessage.BuildernewBuilder(PullMessageprototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
PullMessage |
| Returns | |
|---|---|
| Type | Description |
PullMessage.Builder |
|
parseDelimitedFrom(InputStream input)
publicstaticPullMessageparseDelimitedFrom(InputStreaminput)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
PullMessage |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticPullMessageparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PullMessage |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
publicstaticPullMessageparseFrom(byte[]data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
PullMessage |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticPullMessageparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PullMessage |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
publicstaticPullMessageparseFrom(ByteStringdata)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
PullMessage |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticPullMessageparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PullMessage |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
publicstaticPullMessageparseFrom(CodedInputStreaminput)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
PullMessage |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticPullMessageparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PullMessage |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
publicstaticPullMessageparseFrom(InputStreaminput)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
PullMessage |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticPullMessageparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PullMessage |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
publicstaticPullMessageparseFrom(ByteBufferdata)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
PullMessage |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticPullMessageparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PullMessage |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
publicstaticParser<PullMessage>parser()| Returns | |
|---|---|
| Type | Description |
Parser<PullMessage> |
|
Methods
equals(Object obj)
publicbooleanequals(Objectobj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
publicPullMessagegetDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
PullMessage |
|
getParserForType()
publicParser<PullMessage>getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<PullMessage> |
|
getPayload()
publicByteStringgetPayload()A data payload consumed by the worker to execute the task.
bytes payload = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The payload. |
getSerializedSize()
publicintgetSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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. |
hashCode()
publicinthashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
publicfinalbooleanisInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
publicPullMessage.BuildernewBuilderForType()| Returns | |
|---|---|
| Type | Description |
PullMessage.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedPullMessage.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
PullMessage.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
publicPullMessage.BuildertoBuilder()| Returns | |
|---|---|
| Type | Description |
PullMessage.Builder |
|
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|