Type Alias: SubscriptionUpdate
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
{
eventTime: string;
notification: Notification;
type: "event";
}A stream event record.
eventTime
readonly eventTime: string;The notification's eventTime, as sent.
notification
readonly notification: Notification;The event notification itself.
type
readonly type: "event";What kind of update this is.
Type Literal
{
contents: XmlElement;
eventTime: string;
incomplete: boolean;
notification: Notification;
type: "push-update";
}YANG-Push: the selected datastore contents.
contents
readonly contents: XmlElement;The <datastore-contents> element; its children are the selected data.
eventTime
readonly eventTime: string;The notification's eventTime, as sent.
incomplete
readonly incomplete: boolean;The server couldn't include everything selected.
notification
readonly notification: Notification;The push-update notification it was read from.
type
readonly type: "push-update";What kind of update this is.
Type Literal
{
eventTime: string;
incomplete: boolean;
notification: Notification;
patch: YangPatch;
type: "push-change-update";
}YANG-Push on-change: what changed.
eventTime
readonly eventTime: string;The notification's eventTime, as sent.
incomplete
readonly incomplete: boolean;The server couldn't include every change.
notification
readonly notification: Notification;The push-change-update notification it was read from.
patch
readonly patch: YangPatch;The changes, as an RFC 8072 YANG Patch.
type
readonly type: "push-change-update";What kind of update this is.
Type Literal
{
eventTime: string;
notification: Notification;
reason: string;
type: "suspended";
}The server paused sending; updates may have been lost.
eventTime
readonly eventTime: string;The notification's eventTime, as sent.
notification
readonly notification: Notification;The subscription-suspended notification it was read from.
reason
readonly reason: string;Why, as the reason identity, module-qualified (RFC 7951).
type
readonly type: "suspended";What kind of update this is.
Type Literal
{
eventTime: string;
notification: Notification;
type: "resumed";
}Sending started again. A datastore subscription should resynchronise (resync() for on-change).
eventTime
readonly eventTime: string;The notification's eventTime, as sent.
notification
readonly notification: Notification;The subscription-resumed notification it was read from.
type
readonly type: "resumed";What kind of update this is.