@canonical/jujulib/dist/api/facades/undertaker/UndertakerV1.d.ts

Juju API client

/**
  Juju Undertaker 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 CloudCredential {
    attrs?: Record<string, string>;
    "auth-type": string;
    redacted?: string[];
}
export interface CloudSpec {
    cacertificates?: string[];
    credential?: CloudCredential;
    endpoint?: string;
    "identity-endpoint"?: string;
    "is-controller-cloud"?: boolean;
    name: string;
    region?: string;
    "skip-tls-verify"?: boolean;
    "storage-endpoint"?: string;
    type: string;
}
export interface CloudSpecResult {
    error?: Error;
    result?: CloudSpec;
}
export interface CloudSpecResults {
    results?: CloudSpecResult[];
}
export interface Entities {
    entities: Entity[];
}
export interface Entity {
    tag: string;
}
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 ModelConfigResult {
    config: AdditionalProperties;
}
export interface ModelTag {
    [key: string]: AdditionalProperties;
}
export interface NotifyWatchResult {
    NotifyWatcherId: string;
    error?: Error;
}
export interface NotifyWatchResults {
    results: NotifyWatchResult[];
}
export interface SetStatus {
    entities: EntityStatusArgs[];
}
export interface UndertakerModelInfo {
    "destroy-timeout"?: number;
    "force-destroyed"?: boolean;
    "global-name": string;
    "is-system": boolean;
    life: string;
    name: string;
    uuid: string;
}
export interface UndertakerModelInfoResult {
    error?: Error;
    result: UndertakerModelInfo;
}
export interface AdditionalProperties {
    [key: string]: any;
}
/**
  UndertakerAPI implements the API used by the model undertaker worker.
*/
declare class UndertakerV1 implements Facade {
    static NAME: string;
    static VERSION: number;
    NAME: string;
    VERSION: number;
    _transport: Transport;
    _info: ConnectionInfo;
    constructor(transport: Transport, info: ConnectionInfo);
    /**
      CloudSpec returns the model's cloud spec.
    */
    cloudSpec(params: Entities): Promise<CloudSpecResults>;
    /**
      GetCloudSpec constructs the CloudSpec for a validated and authorized model.
    */
    getCloudSpec(params: ModelTag): Promise<CloudSpecResult>;
    /**
      ModelConfig returns the current model's configuration.
    */
    modelConfig(params: any): Promise<ModelConfigResult>;
    /**
      ModelInfo returns information on the model needed by the undertaker worker.
    */
    modelInfo(params: any): Promise<UndertakerModelInfoResult>;
    /**
      ProcessDyingModel checks if a dying model has any machines or applications.
      If there are none, the model's life is changed from dying to dead.
    */
    processDyingModel(params: any): Promise<any>;
    /**
      RemoveModel removes any records of this model from Juju.
    */
    removeModel(params: any): Promise<any>;
    /**
      SetStatus sets the status of each given entity.
    */
    setStatus(params: SetStatus): Promise<ErrorResults>;
    /**
      WatchCloudSpecsChanges returns a watcher for cloud spec changes.
    */
    watchCloudSpecsChanges(params: Entities): Promise<NotifyWatchResults>;
    /**
      WatchForModelConfigChanges returns a NotifyWatcher that observes
      changes to the model configuration.
      Note that although the NotifyWatchResult contains an Error field,
      it's not used because we are only returning a single watcher,
      so we use the regular error return.
    */
    watchForModelConfigChanges(params: any): Promise<NotifyWatchResult>;
    /**
      WatchModel creates a watcher for the current model.
    */
    watchModel(params: any): Promise<NotifyWatchResults>;
    /**
      WatchModelResources creates watchers for changes to the lifecycle of an
      model's machines and applications and storage.
    */
    watchModelResources(params: any): Promise<NotifyWatchResults>;
}
export default UndertakerV1;