Class PartitionDescription

Namespace

Microsoft.ServiceBus.Messaging

Assembly

Microsoft.ServiceBus.dll

Represents the metadata and approximate runtime information for a logical partition of an Event Hub.

[DataContract(Name = "PartitionDescription", Namespace = "http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")]
public sealed class PartitionDescription : EntityDescription, IExtensibleDataObject

Inheritance

object

EntityDescription

PartitionDescription

Implements

IExtensibleDataObject

Inherited Members

EntityDescription.IsReadOnly

EntityDescription.ExtensionData

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PartitionDescription(string, string)

Initializes a new instance of the PartitionDescription class.

public PartitionDescription(string eventHubPath, string partitionId)

Parameters

eventHubPath string

The path of the Event Hub.

partitionId string

The partition identifier.

Properties

BeginSequenceNumber

Gets the begin sequence number.

public long BeginSequenceNumber { get; }

Property Value

long

The begin sequence number.

ConsumerGroupName

Gets the name of the Event Hubs consumer group.

public string ConsumerGroupName { get; }

Property Value

string

The Event Hubs consumer group.

EndSequenceNumber

Gets the end sequence number.

public long EndSequenceNumber { get; }

Property Value

long

The end sequence number.

EventHubPath

Gets the path of the Event Hub.

public string EventHubPath { get; }

Property Value

string

The path of the Event Hub.

Remarks

This is a relative path to the Address.

IncomingBytesPerSecond

Gets the approximate incoming rate of events (in bytes per second) for the partition.

public long IncomingBytesPerSecond { get; }

Property Value

long

Returns long.

LastEnqueuedOffset

Gets the offset of the last enqueued event.

public string LastEnqueuedOffset { get; }

Property Value

string

The offset of the last enqueued event.

LastEnqueuedTimeUtc

Gets the enqueued UTC time of the last event.

public DateTime LastEnqueuedTimeUtc { get; }

Property Value

DateTime

The enqueued time of the last event.

OutgoingBytesPerSecond

Gets the approximate outgoing rate (in bytes per second) for the partition in the specified consumer group.

public long OutgoingBytesPerSecond { get; }

Property Value

long

Returns long.

PartitionId

Gets the partition ID for the Event Hub to which it belongs.

public string PartitionId { get; }

Property Value

string

The partition identifier.

SizeInBytes

Gets the approximate size, in bytes, of the Event Hubs partition.

public long SizeInBytes { get; }

Property Value

long

Returns long.