@canonical/jujulib/dist/api/facades/deployer/DeployerV1.d.ts

Juju API client

/**
  Juju Deployer version 1.
  This facade is available on:
    Controller-machine-agent
    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 { ConnectionInfo, Transport } from "../../client.js";
import { Facade } from "../../types.js";
export interface APIHostPortsResult {
    servers: HostPort[][];
}
export interface Address {
    cidr?: string;
    "config-type"?: string;
    "is-secondary"?: boolean;
    scope: string;
    "space-id"?: string;
    "space-name"?: string;
    type: string;
    value: string;
}
export interface DeployerConnectionValues {
    "api-addresses": string[];
}
export interface Entities {
    entities: Entity[];
}
export interface Entity {
    tag: string;
}
export interface EntityPassword {
    password: string;
    tag: string;
}
export interface EntityPasswords {
    changes: EntityPassword[];
}
export interface EntityStatusArgs {
    data: AdditionalProperties;
    info: string;
    status: string;
    tag: string;
}
export interface Error {
    code: string;
    info?: AdditionalProperties;
    message: string;
}
export interface ErrorResult {
    error?: Error;
}
export interface ErrorResults {
    results: ErrorResult[];
}
export interface HostPort {
    Address: Address;
    cidr?: string;
    "config-type"?: string;
    "is-secondary"?: boolean;
    port: number;
    scope: string;
    "space-id"?: string;
    "space-name"?: string;
    type: string;
    value: string;
}
export interface LifeResult {
    error?: Error;
    life: string;
}
export interface LifeResults {
    results: LifeResult[];
}
export interface NotifyWatchResult {
    NotifyWatcherId: string;
    error?: Error;
}
export interface SetStatus {
    entities: EntityStatusArgs[];
}
export interface StringResult {
    error?: Error;
    result: string;
}
export interface StringsResult {
    error?: Error;
    result?: string[];
}
export interface StringsWatchResult {
    changes?: string[];
    error?: Error;
    "watcher-id": string;
}
export interface StringsWatchResults {
    results: StringsWatchResult[];
}
export interface AdditionalProperties {
    [key: string]: any;
}
/**
  DeployerAPI provides access to the Deployer API facade.
*/
declare class DeployerV1 implements Facade {
    static NAME: string;
    static VERSION: number;
    NAME: string;
    VERSION: number;
    _transport: Transport;
    _info: ConnectionInfo;
    constructor(transport: Transport, info: ConnectionInfo);
    /**
      APIAddresses returns the list of addresses used to connect to the API.
    */
    aPIAddresses(params: any): Promise<StringsResult>;
    /**
      APIHostPorts returns the API server addresses.
    */
    aPIHostPorts(params: any): Promise<APIHostPortsResult>;
    /**
      ConnectionInfo returns all the address information that the
      deployer task needs in one call.
    */
    connectionInfo(params: any): Promise<DeployerConnectionValues>;
    /**
      Life returns the life status of every supplied entity, where available.
    */
    life(params: Entities): Promise<LifeResults>;
    /**
      ModelUUID returns the model UUID that this facade is deploying into.
      It is implemented here directly as a result of removing it from
      embedded APIAddresser *without* bumping the facade version.
      It should be blanked when this facade version is next incremented.
    */
    modelUUID(params: any): Promise<StringResult>;
    /**
      Remove removes every given entity from state, calling EnsureDead
      first, then Remove. It will fail if the entity is not present.
    */
    remove(params: Entities): Promise<ErrorResults>;
    /**
      SetPasswords sets the given password for each supplied entity, if possible.
    */
    setPasswords(params: EntityPasswords): Promise<ErrorResults>;
    /**
      SetStatus sets the status of the specified entities.
    */
    setStatus(params: SetStatus): Promise<ErrorResults>;
    /**
      WatchAPIHostPorts watches the API server addresses.
    */
    watchAPIHostPorts(params: any): Promise<NotifyWatchResult>;
    /**
      WatchUnits starts a StringsWatcher to watch all units belonging to
      to any entity (machine or service) passed in args.
    */
    watchUnits(params: Entities): Promise<StringsWatchResults>;
}
export default DeployerV1;