Package com.google.pubsub.v1

Interface ReceivedMessageOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ReceivedMessage, ReceivedMessage.Builder
public interface ReceivedMessageOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAckId()
    Optional.
    com.google.protobuf.ByteString
    getAckIdBytes()
    Optional.
    int
    getDeliveryAttempt()
    Optional.
    PubsubMessage
    getMessage()
    Optional.
    PubsubMessageOrBuilder
    getMessageOrBuilder()
    Optional.
    boolean
    hasMessage()
    Optional.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getAckId

      String getAckId()
       Optional. This ID can be used to acknowledge the received message.
      string ack_id = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The ackId.

    • getAckIdBytes

      com.google.protobuf.ByteString getAckIdBytes()
       Optional. This ID can be used to acknowledge the received message.
      string ack_id = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for ackId.

    • hasMessage

      boolean hasMessage()
       Optional. The message.
      .google.pubsub.v1.PubsubMessage message = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the message field is set.

    • getMessage

      PubsubMessage getMessage()
       Optional. The message.
      .google.pubsub.v1.PubsubMessage message = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The message.

    • getMessageOrBuilder

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

    • getDeliveryAttempt

      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:
      The deliveryAttempt.