Class PullMessage (2.46.0) 

public final class PullMessage extends GeneratedMessageV3 implements PullMessageOrBuilder

Pull Message.

This proto can only be used for tasks in a queue which has PULL type. It currently exists for backwards compatibility with the App Engine Task Queue SDK. This message type maybe returned with methods list and get, when the response view is FULL.

Protobuf type google.cloud.tasks.v2beta3.PullMessage

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PullMessage

Static Fields

PAYLOAD_FIELD_NUMBER

public static final int PAYLOAD_FIELD_NUMBER
Field Value
Type Description
int

TAG_FIELD_NUMBER

public static final int TAG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PullMessage getDefaultInstance()
Returns
Type Description
PullMessage

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PullMessage.Builder newBuilder()
Returns
Type Description
PullMessage.Builder

newBuilder(PullMessage prototype)

public static PullMessage.Builder newBuilder(PullMessage prototype)
Parameter
Name Description
prototype PullMessage
Returns
Type Description
PullMessage.Builder

parseDelimitedFrom(InputStream input)

public static PullMessage parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PullMessage
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PullMessage parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PullMessage
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PullMessage parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PullMessage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PullMessage parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PullMessage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PullMessage parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PullMessage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PullMessage parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PullMessage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PullMessage parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PullMessage
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PullMessage parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PullMessage
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PullMessage parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PullMessage
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PullMessage parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PullMessage
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PullMessage parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PullMessage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PullMessage parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PullMessage
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PullMessage> parser()
Returns
Type Description
Parser<PullMessage>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public PullMessage getDefaultInstanceForType()
Returns
Type Description
PullMessage

getParserForType()

public Parser<PullMessage> getParserForType()
Returns
Type Description
Parser<PullMessage>
Overrides

getPayload()

public ByteString getPayload()

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

bytes payload = 1;

Returns
Type Description
ByteString

The payload.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTag()

public String getTag()

The tasks's tag.

The tag is 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 tasks's tag.

The tag is 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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PullMessage.Builder newBuilderForType()
Returns
Type Description
PullMessage.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PullMessage.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PullMessage.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PullMessage.Builder toBuilder()
Returns
Type Description
PullMessage.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException