Class ReceivedMessage (1.133.0)

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
Type Description
int

DELIVERY_ATTEMPT_FIELD_NUMBER

public static final int DELIVERY_ATTEMPT_FIELD_NUMBER
Field Value
Type Description
int

MESSAGE_FIELD_NUMBER

public static final int MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ReceivedMessage getDefaultInstance()
Returns
Type Description
ReceivedMessage

getDescriptor()

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

newBuilder()

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

newBuilder(ReceivedMessage prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for ackId.

getDefaultInstanceForType()

public ReceivedMessage getDefaultInstanceForType()
Returns
Type Description
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
Type Description
int

The deliveryAttempt.

getMessage()

public PubsubMessage getMessage()

Optional. The message.

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

Returns
Type Description
PubsubMessage

The message.

getMessageOrBuilder()

public PubsubMessageOrBuilder getMessageOrBuilder()

Optional. The message.

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

Returns
Type Description
PubsubMessageOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasMessage()

public boolean hasMessage()

Optional. The message.

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

Returns
Type Description
boolean

Whether the message field is set.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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