Share via

LastEnqueuedEventProperties Class

  • Reference
Package:
com.azure.messaging.eventhubs.models
Maven Artifact:
com.azure:azure-messaging-eventhubs:5.19.1
  • java.lang.Object
    • com.azure.messaging.eventhubs.models.LastEnqueuedEventProperties

public class LastEnqueuedEventProperties

A set of information about the enqueued state of a partition, as observed by the consumer.

Constructor Summary

Constructor Description
LastEnqueuedEventProperties(Long lastSequenceNumber, Long lastOffset, Instant lastEnqueuedTime, Instant retrievalTime)

Creates an instance with the last enqueued event information set.

Method Summary

Modifier and Type Method and Description
Instant getEnqueuedTime()

Gets the date and time, in UTC, that the last observed event was enqueued in the partition.
Long getOffset()

Gets the offset of the last observed event enqueued in the partition.
Instant getRetrievalTime()

Gets the date and time, in UTC, that the information about the last enqueued event was retrieved.
Long getSequenceNumber()

Gets the sequence number of the last observed event to be enqueued in the partition.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

LastEnqueuedEventProperties

public LastEnqueuedEventProperties(Long lastSequenceNumber, Long lastOffset, Instant lastEnqueuedTime, Instant retrievalTime)

Creates an instance with the last enqueued event information set.

Parameters:

lastSequenceNumber - Sequence number of the last event to be enqueued in a partition. null if the information has not been retrieved, yet.
lastOffset - Offset of the last observed event enqueued in a partition. null if the information has not been retrieved, yet.
lastEnqueuedTime - The date and time of the last observed event enqueued in a partition. null if the information has not been retrieved, yet.
retrievalTime - The date and time that the information was retrieved. null if the information has not been retrieved, yet.

Method Details

getEnqueuedTime

public Instant getEnqueuedTime()

Gets the date and time, in UTC, that the last observed event was enqueued in the partition.

Returns:

The date and time, in UTC, that the last observed event was enqueued in the partition. null if the information has not been retrieved, yet.

getOffset

public Long getOffset()

Gets the offset of the last observed event enqueued in the partition.

Returns:

The offset of the last observed event enqueued in the partition. null if the information has not been retrieved, yet.

getRetrievalTime

public Instant getRetrievalTime()

Gets the date and time, in UTC, that the information about the last enqueued event was retrieved.

Returns:

The date and time, in UTC, that the information about the last enqueued event was retrieved. null if the information has not been retrieved, yet.

getSequenceNumber

public Long getSequenceNumber()

Gets the sequence number of the last observed event to be enqueued in the partition.

Returns:

The sequence number of the last observed event to be enqueued in the partition. null if the information has not been retrieved, yet.

Applies to