@canonical/jujulib
Version:
Juju API client
61 lines (59 loc) • 1.77 kB
TypeScript
/**
Juju RelationUnitsWatcher version 1.
This facade is available on:
Controller-machine-agent
Machine-agent
Unit-agent
Models
NOTE: This file was generated using the Juju schema
from Juju 3.3 at the git SHA 65fa4c1ee5.
Do not manually edit this file.
*/
import { ConnectionInfo, Transport } from "../../client.js";
import { Facade } from "../../types.js";
export interface Error {
code: string;
info?: AdditionalProperties;
message: string;
}
export interface RelationUnitsChange {
"app-changed"?: Record<string, number>;
changed: Record<string, UnitSettings>;
departed?: string[];
}
export interface RelationUnitsWatchResult {
changes: RelationUnitsChange;
error?: Error;
"watcher-id": string;
}
export interface UnitSettings {
version: number;
}
export interface AdditionalProperties {
[key: string]: any;
}
/**
srvRelationUnitsWatcher defines the API wrapping a state.RelationUnitsWatcher.
It notifies about units entering and leaving the scope of a RelationUnit,
and changes to the settings of those units known to have entered.
*/
declare class RelationUnitsWatcherV1 implements Facade {
static NAME: string;
static VERSION: number;
NAME: string;
VERSION: number;
_transport: Transport;
_info: ConnectionInfo;
constructor(transport: Transport, info: ConnectionInfo);
/**
Next returns when a change has occurred to an entity of the
collection being watched since the most recent call to Next
or the Watch call that created the srvRelationUnitsWatcher.
*/
next(params: any): Promise<RelationUnitsWatchResult>;
/**
Stop stops the watcher.
*/
stop(params: any): Promise<any>;
}
export default RelationUnitsWatcherV1;