@canonical/jujulib/api/facades/relation-units-watcher/RelationUnitsWatcherV1.ts

Juju API client

/**
  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 type { JujuRequest } from "../../../generator/interfaces.js";
import { ConnectionInfo, Transport } from "../../client.js";
import { Facade } from "../../types.js";
import { autoBind } from "../../utils.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.
*/
class RelationUnitsWatcherV1 implements Facade {
  static NAME = "RelationUnitsWatcher";
  static VERSION = 1;

  NAME = "RelationUnitsWatcher";
  VERSION = 1;

  _transport: Transport;
  _info: ConnectionInfo;

  constructor(transport: Transport, info: ConnectionInfo) {
    this._transport = transport;
    this._info = info;

    // Automatically bind all methods to instances.
    autoBind(this);
  }
  /**
    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> {
    return new Promise((resolve, reject) => {
      const req: JujuRequest = {
        type: "RelationUnitsWatcher",
        request: "Next",
        version: 1,
        params: params,
      };

      this._transport.write(req, resolve, reject);
    });
  }

  /**
    Stop stops the watcher.
  */
  stop(params: any): Promise<any> {
    return new Promise((resolve, reject) => {
      const req: JujuRequest = {
        type: "RelationUnitsWatcher",
        request: "Stop",
        version: 1,
        params: params,
      };

      this._transport.write(req, resolve, reject);
    });
  }
}

export default RelationUnitsWatcherV1;