com.google.pubsub.v1

Class ReceivedMessage

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.pubsub.v1.ReceivedMessage

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ReceivedMessageOrBuilder, Serializable

public final class ReceivedMessage
extends com.google.protobuf.GeneratedMessageV3
implements ReceivedMessageOrBuilder

 A message and its corresponding acknowledgment ID.
 

Protobuf type google.pubsub.v1.ReceivedMessage

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReceivedMessage.Builder A message and its corresponding acknowledgment ID.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACK_ID_FIELD_NUMBER
static int	DELIVERY_ATTEMPT_FIELD_NUMBER
static int	MESSAGE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAckId() This ID can be used to acknowledge the received message.
com.google.protobuf.ByteString	getAckIdBytes() This ID can be used to acknowledge the received message.
static ReceivedMessage	getDefaultInstance()
ReceivedMessage	getDefaultInstanceForType()
int	getDeliveryAttempt() The approximate number of times that Cloud Pub/Sub has attempted to deliver the associated message to a subscriber.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
PubsubMessage	getMessage() The message.
PubsubMessageOrBuilder	getMessageOrBuilder() The message.
com.google.protobuf.Parser<ReceivedMessage>	getParserForType()
int	getSerializedSize()
int	hashCode()
boolean	hasMessage() The message.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ReceivedMessage.Builder	newBuilder()
static ReceivedMessage.Builder	newBuilder(ReceivedMessage prototype)
ReceivedMessage.Builder	newBuilderForType()
protected ReceivedMessage.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ReceivedMessage	parseDelimitedFrom(InputStream input)
static ReceivedMessage	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReceivedMessage	parseFrom(byte[] data)
static ReceivedMessage	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReceivedMessage	parseFrom(ByteBuffer data)
static ReceivedMessage	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReceivedMessage	parseFrom(com.google.protobuf.ByteString data)
static ReceivedMessage	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReceivedMessage	parseFrom(com.google.protobuf.CodedInputStream input)
static ReceivedMessage	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ReceivedMessage	parseFrom(InputStream input)
static ReceivedMessage	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ReceivedMessage>	parser()
ReceivedMessage.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ACK_ID_FIELD_NUMBER

public static final int ACK_ID_FIELD_NUMBER

See Also:

Constant Field Values

MESSAGE_FIELD_NUMBER

public static final int MESSAGE_FIELD_NUMBER

See Also:

Constant Field Values

DELIVERY_ATTEMPT_FIELD_NUMBER

public static final int DELIVERY_ATTEMPT_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getAckId

public String getAckId()

 This ID can be used to acknowledge the received message.
 

string ack_id = 1;

Specified by:

getAckId in interface ReceivedMessageOrBuilder

Returns:

The ackId.

getAckIdBytes

public com.google.protobuf.ByteString getAckIdBytes()

 This ID can be used to acknowledge the received message.
 

string ack_id = 1;

Specified by:

getAckIdBytes in interface ReceivedMessageOrBuilder

Returns:

The bytes for ackId.

hasMessage

public boolean hasMessage()

 The message.
 

.google.pubsub.v1.PubsubMessage message = 2;

Specified by:

hasMessage in interface ReceivedMessageOrBuilder

Returns:

Whether the message field is set.

getMessage

public PubsubMessage getMessage()

 The message.
 

.google.pubsub.v1.PubsubMessage message = 2;

Specified by:

getMessage in interface ReceivedMessageOrBuilder

Returns:

The message.

getMessageOrBuilder

public PubsubMessageOrBuilder getMessageOrBuilder()

 The message.
 

.google.pubsub.v1.PubsubMessage message = 2;

Specified by:

getMessageOrBuilder in interface ReceivedMessageOrBuilder

getDeliveryAttempt

public int getDeliveryAttempt()

 The approximate number of times that Cloud 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;

Specified by:

getDeliveryAttempt in interface ReceivedMessageOrBuilder

Returns:

The deliveryAttempt.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ReceivedMessage parseFrom(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ReceivedMessage parseFrom(ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ReceivedMessage parseFrom(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ReceivedMessage parseFrom(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ReceivedMessage parseFrom(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ReceivedMessage parseFrom(byte[] data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ReceivedMessage parseFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

public static ReceivedMessage parseFrom(InputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static ReceivedMessage parseDelimitedFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static ReceivedMessage parseDelimitedFrom(InputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Throws:

IOException

parseFrom

public static ReceivedMessage parseFrom(com.google.protobuf.CodedInputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

public static ReceivedMessage parseFrom(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

newBuilderForType

public ReceivedMessage.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ReceivedMessage.Builder newBuilder()

newBuilder

public static ReceivedMessage.Builder newBuilder(ReceivedMessage prototype)

toBuilder

public ReceivedMessage.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ReceivedMessage.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ReceivedMessage getDefaultInstance()

parser

public static com.google.protobuf.Parser<ReceivedMessage> parser()

getParserForType

public com.google.protobuf.Parser<ReceivedMessage> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ReceivedMessage getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder