public final class ReceivedMessage extends GeneratedMessageV3 implements ReceivedMessageOrBuilder
A message and its corresponding acknowledgment ID.
Protobuf type google.pubsub.v1.ReceivedMessage
Inherited 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>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ReceivedMessage.Builder newBuilder()
newBuilder(ReceivedMessage prototype)
public static ReceivedMessage.Builder newBuilder(ReceivedMessage prototype)
public static ReceivedMessage parseDelimitedFrom(InputStream input)
public static ReceivedMessage parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ReceivedMessage parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ReceivedMessage parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ReceivedMessage parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ReceivedMessage parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ReceivedMessage parseFrom(CodedInputStream input)
public static ReceivedMessage parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ReceivedMessage parseFrom(InputStream input)
public static ReceivedMessage parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ReceivedMessage parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ReceivedMessage parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ReceivedMessage> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
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()
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];
getMessageOrBuilder()
public PubsubMessageOrBuilder getMessageOrBuilder()
Optional. The message.
.google.pubsub.v1.PubsubMessage message = 2 [(.google.api.field_behavior) = OPTIONAL];
getParserForType()
public Parser<ReceivedMessage> getParserForType()
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()
Returns |
Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ReceivedMessage.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ReceivedMessage.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public ReceivedMessage.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides