@canonical/jujulib/dist/api/facades/entity-watcher/EntityWatcherV2.d.ts

Juju API client

/**
  Juju EntityWatcher version 2.
  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 EntitiesWatchResult {
    changes?: string[];
    error?: Error;
    "watcher-id": string;
}
export interface Error {
    code: string;
    info?: AdditionalProperties;
    message: string;
}
export interface AdditionalProperties {
    [key: string]: any;
}
/**
  srvEntitiesWatcher defines the API for methods on a state.StringsWatcher.
  Each client has its own current set of watchers, stored in resources.
  srvEntitiesWatcher notifies about changes for all entities of a given kind,
  sending the changes as a list of strings, which could be transformed
  from state entity ids to their corresponding entity tags.
*/
declare class EntityWatcherV2 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 srvEntitiesWatcher.
    */
    next(params: any): Promise<EntitiesWatchResult>;
    /**
      Stop stops the watcher.
    */
    stop(params: any): Promise<any>;
}
export default EntityWatcherV2;