Packages

c

com.google.pubsub.v1

ReceivedMessage

final class ReceivedMessage extends GeneratedMessageV3 with ReceivedMessageOrBuilder

A message and its corresponding acknowledgment ID.

Protobuf type google.pubsub.v1.ReceivedMessage

Source
ReceivedMessage.java
Linear Supertypes
ReceivedMessageOrBuilder, GeneratedMessageV3, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReceivedMessage
  2. ReceivedMessageOrBuilder
  3. GeneratedMessageV3
  4. Serializable
  5. AbstractMessage
  6. Message
  7. MessageOrBuilder
  8. AbstractMessageLite
  9. MessageLite
  10. MessageLiteOrBuilder
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(obj: AnyRef): Boolean
    Definition Classes
    ReceivedMessage → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  10. def getAckId(): String

    This ID can be used to acknowledge the received message.


    This ID can be used to acknowledge the received message.

    string ack_id = 1;

    returns

    The ackId.

    Definition Classes
    ReceivedMessage → ReceivedMessageOrBuilder
    Annotations
    @Override()
  11. def getAckIdBytes(): ByteString

    This ID can be used to acknowledge the received message.


    This ID can be used to acknowledge the received message.

    string ack_id = 1;

    returns

    The bytes for ackId.

    Definition Classes
    ReceivedMessage → ReceivedMessageOrBuilder
    Annotations
    @Override()
  12. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def getDefaultInstanceForType(): ReceivedMessage
    Definition Classes
    ReceivedMessage → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  15. def getDeliveryAttempt(): Int

    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.


    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;

    returns

    The deliveryAttempt.

    Definition Classes
    ReceivedMessage → ReceivedMessageOrBuilder
    Annotations
    @Override()
  16. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  17. def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  18. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  19. def getMessage(): PubsubMessage

    The message.


    The message.

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

    returns

    The message.

    Definition Classes
    ReceivedMessage → ReceivedMessageOrBuilder
    Annotations
    @Override()
  20. def getMessageOrBuilder(): PubsubMessageOrBuilder

    The message.


    The message.

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

    Definition Classes
    ReceivedMessage → ReceivedMessageOrBuilder
    Annotations
    @Override()
  21. def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  22. def getParserForType(): Parser[ReceivedMessage]
    Definition Classes
    ReceivedMessage → GeneratedMessageV3 → Message → MessageLite
    Annotations
    @Override()
  23. def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  24. def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  25. def getSerializedSize(): Int
    Definition Classes
    ReceivedMessage → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  26. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  27. def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  28. def hasMessage(): Boolean

    The message.


    The message.

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

    returns

    Whether the message field is set.

    Definition Classes
    ReceivedMessage → ReceivedMessageOrBuilder
    Annotations
    @Override()
  29. def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  30. def hashCode(): Int
    Definition Classes
    ReceivedMessage → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  31. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[v1]
    Definition Classes
    ReceivedMessage → GeneratedMessageV3
    Annotations
    @Override()
  32. def internalGetMapField(arg0: Int): MapField[_ <: AnyRef, _ <: AnyRef]
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  33. final def isInitialized(): Boolean
    Definition Classes
    ReceivedMessage → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  34. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  35. def makeExtensionsImmutable(): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  36. def mergeFromAndMakeImmutableInternal(arg0: CodedInputStream, arg1: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[com.google.protobuf.InvalidProtocolBufferException])
  37. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[v1]
    Definition Classes
    ReceivedMessage → GeneratedMessageV3
    Annotations
    @Override()
  39. def newBuilderForType(): Builder
    Definition Classes
    ReceivedMessage → Message → MessageLite
    Annotations
    @Override()
  40. def newBuilderForType(arg0: BuilderParent): Builder
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3 → AbstractMessage
  41. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[v1]
    Definition Classes
    ReceivedMessage → GeneratedMessageV3
    Annotations
    @Override() @SuppressWarnings()
  42. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  43. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  44. def parseUnknownField(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  45. def parseUnknownFieldProto3(arg0: CodedInputStream, arg1: Builder, arg2: ExtensionRegistryLite, arg3: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.IOException])
  46. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  47. def toBuilder(): Builder
    Definition Classes
    ReceivedMessage → Message → MessageLite
    Annotations
    @Override()
  48. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  49. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  50. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  51. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  52. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  53. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  54. def writeDelimitedTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])
  55. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws(classOf[java.io.ObjectStreamException])
  56. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    ReceivedMessage → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  57. def writeTo(arg0: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])

Inherited from ReceivedMessageOrBuilder

Inherited from GeneratedMessageV3

Inherited from Serializable

Inherited from AbstractMessage

Inherited from Message

Inherited from MessageOrBuilder

Inherited from AbstractMessageLite[MessageType, BuilderType]

Inherited from MessageLite

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped