Class ReceivedMessage (1.126.6)

public final class ReceivedMessage extends GeneratedMessageV3 implements ReceivedMessageOrBuilder

A message and its corresponding acknowledgment ID.

Protobuf type google.pubsub.v1.ReceivedMessage

Static Fields

ACK_ID_FIELD_NUMBER

public static final int ACK_ID_FIELD_NUMBER
Field Value
TypeDescription
int

DELIVERY_ATTEMPT_FIELD_NUMBER

public static final int DELIVERY_ATTEMPT_FIELD_NUMBER
Field Value
TypeDescription
int

MESSAGE_FIELD_NUMBER

public static final int MESSAGE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ReceivedMessage getDefaultInstance()
Returns
TypeDescription
ReceivedMessage

getDescriptor()

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

newBuilder()

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

newBuilder(ReceivedMessage prototype)

public static ReceivedMessage.Builder newBuilder(ReceivedMessage prototype)
Parameter
NameDescription
prototypeReceivedMessage
Returns
TypeDescription
ReceivedMessage.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAckId()

public String getAckId()

Optional. This ID can be used to acknowledge the received message.

string ack_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The ackId.

getAckIdBytes()

public ByteString getAckIdBytes()

Optional. This ID can be used to acknowledge the received message.

string ack_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for ackId.

getDefaultInstanceForType()

public ReceivedMessage getDefaultInstanceForType()
Returns
TypeDescription
ReceivedMessage

getDeliveryAttempt()

public int getDeliveryAttempt()

Optional. The approximate number of times that Pub/Sub has attempted to deliver the associated message to a subscriber.

More precisely, this is 1 + (number of NACKs) + (number of ack_deadline exceeds) for this message.

A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds event is whenever a message is not acknowledged within ack_deadline. Note that ack_deadline is initially Subscription.ackDeadlineSeconds, but may get extended automatically by the client library.

Upon the first delivery of a given message, delivery_attempt will have a value of 1. The value is calculated at best effort and is approximate.

If a DeadLetterPolicy is not set on the subscription, this will be 0.

int32 delivery_attempt = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The deliveryAttempt.

getMessage()

public PubsubMessage getMessage()

Optional. The message.

.google.pubsub.v1.PubsubMessage message = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
PubsubMessage

The message.

getMessageOrBuilder()

public PubsubMessageOrBuilder getMessageOrBuilder()

Optional. The message.

.google.pubsub.v1.PubsubMessage message = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
PubsubMessageOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasMessage()

public boolean hasMessage()

Optional. The message.

.google.pubsub.v1.PubsubMessage message = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the message field is set.

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 ReceivedMessage.Builder newBuilderForType()
Returns
TypeDescription
ReceivedMessage.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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