Show / Hide Table of Contents

Struct LastEnqueuedEventProperties

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

Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Messaging.EventHubs.dll
Syntax
public struct LastEnqueuedEventProperties : IEquatable<Azure.Messaging.EventHubs.Consumer.LastEnqueuedEventProperties>

Constructors

LastEnqueuedEventProperties(Nullable<Int64>, Int64, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>)

Obsolete.

Initializes a new instance of the LastEnqueuedEventProperties class.

Declaration
[System.ComponentModel.EditorBrowsable]
[System.Obsolete("The Event Hubs service does not guarantee a numeric offset for all resource configurations.  Please use the overload with a string-based offset instead.", false)]
public LastEnqueuedEventProperties (Nullable<long> lastSequenceNumber, long lastOffset, Nullable<DateTimeOffset> lastEnqueuedTime, Nullable<DateTimeOffset> lastReceivedTime);
Parameters
System.Nullable<System.Int64> lastSequenceNumber

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

System.Int64 lastOffset

The offset of the last event to be enqueued in the partition.

System.Nullable<System.DateTimeOffset> lastEnqueuedTime

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

System.Nullable<System.DateTimeOffset> lastReceivedTime

The date and time, in UTC, that the information was last received.

Remarks

This constructor is obsolete and should no longer be used. Please use the string-based offset overload instead.

LastEnqueuedEventProperties(Nullable<Int64>, Nullable<Int64>, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>)

Obsolete.

Initializes a new instance of the LastEnqueuedEventProperties class.

Declaration
[System.ComponentModel.EditorBrowsable]
[System.Obsolete("The Event Hubs service does not guarantee a numeric offset for all resource configurations.  Please use the overload with a string-based offset instead.", false)]
public LastEnqueuedEventProperties (Nullable<long> lastSequenceNumber, Nullable<long> lastOffset, Nullable<DateTimeOffset> lastEnqueuedTime, Nullable<DateTimeOffset> lastReceivedTime);
Parameters
System.Nullable<System.Int64> lastSequenceNumber

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

System.Nullable<System.Int64> lastOffset

The offset of the last event to be enqueued in the partition.

System.Nullable<System.DateTimeOffset> lastEnqueuedTime

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

System.Nullable<System.DateTimeOffset> lastReceivedTime

The date and time, in UTC, that the information was last received.

Remarks

This constructor is obsolete and should no longer be used. Please use the string-based offset overload instead.

LastEnqueuedEventProperties(Nullable<Int64>, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>)

Initializes a new instance of the LastEnqueuedEventProperties class.

Declaration
public LastEnqueuedEventProperties (Nullable<long> lastSequenceNumber, string lastOffsetString, Nullable<DateTimeOffset> lastEnqueuedTime, Nullable<DateTimeOffset> lastReceivedTime);
Parameters
System.Nullable<System.Int64> lastSequenceNumber

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

System.String lastOffsetString

The offset of the last event to be enqueued in the partition.

System.Nullable<System.DateTimeOffset> lastEnqueuedTime

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

System.Nullable<System.DateTimeOffset> lastReceivedTime

The date and time, in UTC, that the information was last received.

Properties

EnqueuedTime

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

Declaration
public Nullable<DateTimeOffset> EnqueuedTime { get; }
Property Value
System.Nullable<System.DateTimeOffset>

LastReceivedTime

The date and time, in UTC, that the information about the last enqueued event was received.

Declaration
public Nullable<DateTimeOffset> LastReceivedTime { get; }
Property Value
System.Nullable<System.DateTimeOffset>

Offset

Obsolete. A numeric representation of the offset of the last observed event to be enqueued in the partition.

Declaration
[System.ComponentModel.EditorBrowsable]
[System.Obsolete("The Event Hubs service does not guarantee a numeric offset for all resource configurations.  Please use 'OffsetString' instead.", false)]
public Nullable<long> Offset { get; }
Property Value
System.Nullable<System.Int64>

This value is obsolete and should no longer be used. Please use OffsetString instead.

OffsetString

The offset of the last observed event to be enqueued in the partition.

Declaration
public string OffsetString { get; }
Property Value
System.String

SequenceNumber

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

Declaration
public Nullable<long> SequenceNumber { get; }
Property Value
System.Nullable<System.Int64>

Methods

Equals(LastEnqueuedEventProperties)

Determines whether the specified LastEnqueuedEventProperties is equal to this instance.

Declaration
public bool Equals (Azure.Messaging.EventHubs.Consumer.LastEnqueuedEventProperties other);
Parameters
LastEnqueuedEventProperties other

The LastEnqueuedEventProperties to compare with this instance.

Returns
System.Boolean

true if the specified LastEnqueuedEventProperties is equal to this instance; otherwise, false.

Equals(Object)

Determines whether the specified System.Object is equal to this instance.

Declaration
[System.ComponentModel.EditorBrowsable]
public override bool Equals (object obj);
Parameters
System.Object obj

The System.Object to compare with this instance.

Returns
System.Boolean

true if the specified System.Object is equal to this instance; otherwise, false.

GetHashCode()

Returns a hash code for this instance.

Declaration
[System.ComponentModel.EditorBrowsable]
public override int GetHashCode ();
Returns
System.Int32

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

ToString()

Converts the instance to string representation.

Declaration
[System.ComponentModel.EditorBrowsable]
public override string ToString ();
Returns
System.String

A System.String that represents this instance.

Operators

Equality(LastEnqueuedEventProperties, LastEnqueuedEventProperties)

Determines whether the specified LastEnqueuedEventProperties instances are equal to each other.

Declaration
public static bool operator == (Azure.Messaging.EventHubs.Consumer.LastEnqueuedEventProperties left, Azure.Messaging.EventHubs.Consumer.LastEnqueuedEventProperties right);
Parameters
LastEnqueuedEventProperties left

The first LastEnqueuedEventProperties to consider.

LastEnqueuedEventProperties right

The second LastEnqueuedEventProperties to consider.

Returns
System.Boolean

true if the two specified LastEnqueuedEventProperties instances are equal; otherwise, false.

Inequality(LastEnqueuedEventProperties, LastEnqueuedEventProperties)

Determines whether the specified LastEnqueuedEventProperties instances are not equal to each other.

Declaration
public static bool operator != (Azure.Messaging.EventHubs.Consumer.LastEnqueuedEventProperties left, Azure.Messaging.EventHubs.Consumer.LastEnqueuedEventProperties right);
Parameters
LastEnqueuedEventProperties left

The first LastEnqueuedEventProperties to consider.

LastEnqueuedEventProperties right

The second LastEnqueuedEventProperties to consider.

Returns
System.Boolean

true if the two specified LastEnqueuedEventProperties instances are not equal; otherwise, false.

Back to top Azure SDK for .NET