@canonical/jujulib/dist/api/facades/bundle/BundleV4.d.ts

Juju API client

/**
  Juju Bundle version 4.
  This facade is available on:
    Controllers
    Models

  NOTE: This file was generated using the Juju schema
  from Juju 2.9-rc3 at the git SHA cb361902f8.
  Do not manually edit this file.
*/
import { ConnectionInfo, Transport } from "../../client.js";
import { Facade } from "../../types.js";
export interface BundleChange {
    args: object[];
    id: string;
    method: string;
    requires: string[];
}
export interface BundleChangesMapArgs {
    args: AdditionalProperties;
    id: string;
    method: string;
    requires: string[];
}
export interface BundleChangesMapArgsResults {
    changes?: BundleChangesMapArgs[];
    errors?: string[];
}
export interface BundleChangesParams {
    bundleURL: string;
    yaml: string;
}
export interface BundleChangesResults {
    changes?: BundleChange[];
    errors?: string[];
}
export interface Error {
    code: string;
    info?: AdditionalProperties;
    message: string;
}
export interface StringResult {
    error?: Error;
    result: string;
}
export interface AdditionalProperties {
    [key: string]: any;
}
/**
  APIv4 provides the Bundle API facade for version 4. It is otherwise
  identical to V3 with the exception that the V4 now has GetChangesAsMap, which
  returns the same data as GetChanges, but with better args data.
*/
declare class BundleV4 implements Facade {
    static NAME: string;
    static VERSION: number;
    NAME: string;
    VERSION: number;
    _transport: Transport;
    _info: ConnectionInfo;
    constructor(transport: Transport, info: ConnectionInfo);
    /**
      ExportBundle exports the current model configuration as bundle.
    */
    exportBundle(params: any): Promise<StringResult>;
    /**
      GetChanges returns the list of changes required to deploy the given bundle
      data. The changes are sorted by requirements, so that they can be applied in
      order.
      GetChanges has been superseded in favour of GetChangesMapArgs. It's
      preferable to use that new method to add new functionality and move clients
      away from this one.
    */
    getChanges(params: BundleChangesParams): Promise<BundleChangesResults>;
    /**
      GetChangesMapArgs returns the list of changes required to deploy the given
      bundle data. The changes are sorted by requirements, so that they can be
      applied in order.
      V4 GetChangesMapArgs is not supported on anything less than v4
    */
    getChangesMapArgs(params: BundleChangesParams): Promise<BundleChangesMapArgsResults>;
}
export default BundleV4;