@canonical/jujulib/api/facades/machine-undertaker/MachineUndertakerV1.ts

Juju API client

/**
  Juju MachineUndertaker version 1.
  This facade is available on:
    Controller-machine-agent

  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 Entities {
  entities: Entity[];
}

export interface EntitiesResult {
  entities: Entity[];
  error?: Error;
}

export interface EntitiesResults {
  results: EntitiesResult[];
}

export interface Entity {
  tag: string;
}

export interface Error {
  code: string;
  info?: AdditionalProperties;
  message: string;
}

export interface NotifyWatchResult {
  NotifyWatcherId: string;
  error?: Error;
}

export interface NotifyWatchResults {
  results: NotifyWatchResult[];
}

export interface ProviderInterfaceInfo {
  "interface-name": string;
  "mac-address": string;
  "provider-id": string;
}

export interface ProviderInterfaceInfoResult {
  error?: Error;
  interfaces: ProviderInterfaceInfo[];
  "machine-tag": string;
}

export interface ProviderInterfaceInfoResults {
  results: ProviderInterfaceInfoResult[];
}

export interface AdditionalProperties {
  [key: string]: any;
}

/**
  API implements the API facade used by the machine undertaker.
*/
class MachineUndertakerV1 implements Facade {
  static NAME = "MachineUndertaker";
  static VERSION = 1;

  NAME = "MachineUndertaker";
  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);
  }
  /**
    AllMachineRemovals returns tags for all of the machines that have
    been marked for removal in the requested model.
  */
  allMachineRemovals(params: Entities): Promise<EntitiesResults> {
    return new Promise((resolve, reject) => {
      const req: JujuRequest = {
        type: "MachineUndertaker",
        request: "AllMachineRemovals",
        version: 1,
        params: params,
      };

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

  /**
    CompleteMachineRemovals removes the specified machines from the
    model database. It should only be called once any provider-level
    cleanup has been done for those machines.
  */
  completeMachineRemovals(params: Entities): Promise<any> {
    return new Promise((resolve, reject) => {
      const req: JujuRequest = {
        type: "MachineUndertaker",
        request: "CompleteMachineRemovals",
        version: 1,
        params: params,
      };

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

  /**
    GetMachineProviderInterfaceInfo returns the provider details for
    all network interfaces attached to the machines requested.
  */
  getMachineProviderInterfaceInfo(
    params: Entities
  ): Promise<ProviderInterfaceInfoResults> {
    return new Promise((resolve, reject) => {
      const req: JujuRequest = {
        type: "MachineUndertaker",
        request: "GetMachineProviderInterfaceInfo",
        version: 1,
        params: params,
      };

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

  /**
    WatchMachineRemovals returns a watcher that will signal each time a
    machine is marked for removal.
  */
  watchMachineRemovals(params: Entities): Promise<NotifyWatchResults> {
    return new Promise((resolve, reject) => {
      const req: JujuRequest = {
        type: "MachineUndertaker",
        request: "WatchMachineRemovals",
        version: 1,
        params: params,
      };

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

export default MachineUndertakerV1;