Skip to content

Type Alias: SubscriptionUpdate ​

ts
type SubscriptionUpdate = 
  | {
  eventTime: string;
  notification: Notification;
  type: "event";
}
  | {
  contents: XmlElement;
  eventTime: string;
  incomplete: boolean;
  notification: Notification;
  type: "push-update";
}
  | {
  eventTime: string;
  incomplete: boolean;
  notification: Notification;
  patch: YangPatch;
  type: "push-change-update";
}
  | {
  eventTime: string;
  notification: Notification;
  reason: string;
  type: "suspended";
}
  | {
  eventTime: string;
  notification: Notification;
  type: "resumed";
};

Defined in: netconf/src/operations/subscriptions/types.ts:73

What a subscription delivers, in arrival order.

Union Members ​

Type Literal ​

ts
{
  eventTime: string;
  notification: Notification;
  type: "event";
}

A stream event record.

eventTime ​

ts
readonly eventTime: string;

The notification's eventTime, as sent.

notification ​

ts
readonly notification: Notification;

The event notification itself.

type ​

ts
readonly type: "event";

What kind of update this is.


Type Literal ​

ts
{
  contents: XmlElement;
  eventTime: string;
  incomplete: boolean;
  notification: Notification;
  type: "push-update";
}

YANG-Push: the selected datastore contents.

contents ​

ts
readonly contents: XmlElement;

The <datastore-contents> element; its children are the selected data.

eventTime ​

ts
readonly eventTime: string;

The notification's eventTime, as sent.

incomplete ​

ts
readonly incomplete: boolean;

The server couldn't include everything selected.

notification ​

ts
readonly notification: Notification;

The push-update notification it was read from.

type ​

ts
readonly type: "push-update";

What kind of update this is.


Type Literal ​

ts
{
  eventTime: string;
  incomplete: boolean;
  notification: Notification;
  patch: YangPatch;
  type: "push-change-update";
}

YANG-Push on-change: what changed.

eventTime ​

ts
readonly eventTime: string;

The notification's eventTime, as sent.

incomplete ​

ts
readonly incomplete: boolean;

The server couldn't include every change.

notification ​

ts
readonly notification: Notification;

The push-change-update notification it was read from.

patch ​

ts
readonly patch: YangPatch;

The changes, as an RFC 8072 YANG Patch.

type ​

ts
readonly type: "push-change-update";

What kind of update this is.


Type Literal ​

ts
{
  eventTime: string;
  notification: Notification;
  reason: string;
  type: "suspended";
}

The server paused sending; updates may have been lost.

eventTime ​

ts
readonly eventTime: string;

The notification's eventTime, as sent.

notification ​

ts
readonly notification: Notification;

The subscription-suspended notification it was read from.

reason ​

ts
readonly reason: string;

Why, as the reason identity, module-qualified (RFC 7951).

type ​

ts
readonly type: "suspended";

What kind of update this is.


Type Literal ​

ts
{
  eventTime: string;
  notification: Notification;
  type: "resumed";
}

Sending started again. A datastore subscription should resynchronise (resync() for on-change).

eventTime ​

ts
readonly eventTime: string;

The notification's eventTime, as sent.

notification ​

ts
readonly notification: Notification;

The subscription-resumed notification it was read from.

type ​

ts
readonly type: "resumed";

What kind of update this is.

Released under the MIT Licence.