Class PartitionContext

Package version

Describes the Partition Context.

class: PartitionContext

Hierarchy

PartitionContext

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new PartitionContext(context: HostContextWithCheckpointLeaseManager, partitionId: string, lease: CompleteLease): PartitionContext

- Defined in partitionContext.ts:49
Creates a new PartitionContext.

Parameters
- context: HostContextWithCheckpointLeaseManager
- partitionId: string
  
  The eventhub partition id.
- lease: CompleteLease
  
  The lease object.
Returns PartitionContext

Properties

lease

lease: CompleteLease

property: {Lease} lease The most recdent checkpointed lease with the partitionId.

partitionId

partitionId: string

property: {string} partitionId The eventhub partition id.
readonly

Accessors

consumerGroup

get consumerGroup(): string

- Defined in partitionContext.ts:43
property

{string} consumerGroup The name of the consumer group.

readonly

Returns string

eventhubPath

get eventhubPath(): string

- Defined in partitionContext.ts:36
property

{string} eventhubPath The path of the eventhub

readonly

Returns string

owner

get owner(): string

- Defined in partitionContext.ts:29
property

{string} owner The host/owner of the partition.

readonly

Returns string

Methods

checkpoint

checkpoint(): Promise<void>

- Defined in partitionContext.ts:88
Writes the current offset and sequenceNumber to the checkpoint store via the checkpoint manager.

The checkpoint data is structured as a JSON payload (example): { "partitionId":"0","owner":"ephtest","token":"48e209e3-55f0-41b8-a8dd-d9c09ff6c35a", "epoch":1,"offset":"","SequenceNumber":0 }.

Returns Promise<void>

checkpointFromEventData

checkpointFromEventData(eventData: EventData): Promise<void>

- Defined in partitionContext.ts:111
Writes the current offset and sequenceNumber to the checkpoint store via the checkpoint manager.

The checkpoint data is structured as a JSON payload (example): { "partitionId":"0","owner":"ephtest","token":"48e209e3-55f0-41b8-a8dd-d9c09ff6c35a", "epoch":1,"offset":"","SequenceNumber":0 }.

Parameters
- eventData: EventData
  
  The event data received from the EventHubReceiver.
Returns Promise<void>

setOffsetAndSequenceNumber

setOffsetAndSequenceNumber(eventData: EventData): void

- Defined in partitionContext.ts:71
Sets the offset and sequence number of the partition context from the provided EventData.

Parameters
- eventData: EventData
  
  The event data received from the EventHubReceiver.
Returns void

Generated using TypeDoc