Class PullMessage (2.29.0)

public final class PullMessage extends GeneratedMessageV3 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

Static Fields

PAYLOAD_FIELD_NUMBER

public static final int PAYLOAD_FIELD_NUMBER
Field Value
TypeDescription
int

TAG_FIELD_NUMBER

public static final int TAG_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PullMessage getDefaultInstance()
Returns
TypeDescription
PullMessage

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static PullMessage.Builder newBuilder()
Returns
TypeDescription
PullMessage.Builder

newBuilder(PullMessage prototype)

public static PullMessage.Builder newBuilder(PullMessage prototype)
Parameter
NameDescription
prototypePullMessage
Returns
TypeDescription
PullMessage.Builder

parseDelimitedFrom(InputStream input)

public static PullMessage parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PullMessage
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PullMessage parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PullMessage
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PullMessage parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PullMessage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PullMessage parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PullMessage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PullMessage parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PullMessage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PullMessage parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PullMessage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PullMessage parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PullMessage
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PullMessage parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PullMessage
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PullMessage parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PullMessage
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PullMessage parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PullMessage
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PullMessage parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PullMessage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PullMessage parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PullMessage
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PullMessage> parser()
Returns
TypeDescription
Parser<PullMessage>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public PullMessage getDefaultInstanceForType()
Returns
TypeDescription
PullMessage

getParserForType()

public Parser<PullMessage> getParserForType()
Returns
TypeDescription
Parser<PullMessage>
Overrides

getPayload()

public ByteString getPayload()

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

bytes payload = 1;

Returns
TypeDescription
ByteString

The payload.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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
TypeDescription
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
TypeDescription
ByteString

The bytes for tag.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PullMessage.Builder newBuilderForType()
Returns
TypeDescription
PullMessage.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PullMessage.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PullMessage.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PullMessage.Builder toBuilder()
Returns
TypeDescription
PullMessage.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException