@canonical/jujulib/dist/api/facades/spaces/SpacesV6.d.ts

Juju API client

/**
  Juju Spaces version 6.
  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 CreateSpaceParams {
    cidrs: string[];
    "provider-id"?: string;
    public: boolean;
    "space-tag": string;
}
export interface CreateSpacesParams {
    spaces: CreateSpaceParams[];
}
export interface Entities {
    entities: Entity[];
}
export interface Entity {
    tag: string;
}
export interface Error {
    code: string;
    info?: AdditionalProperties;
    message: string;
}
export interface ErrorResult {
    error?: Error;
}
export interface ErrorResults {
    results: ErrorResult[];
}
export interface ListSpacesResults {
    results: Space[];
}
export interface MoveSubnetsParam {
    force: boolean;
    "space-tag": string;
    subnets: string[];
}
export interface MoveSubnetsParams {
    args: MoveSubnetsParam[];
}
export interface MoveSubnetsResult {
    error?: Error;
    "moved-subnets"?: MovedSubnet[];
    "new-space": string;
}
export interface MoveSubnetsResults {
    results: MoveSubnetsResult[];
}
export interface MovedSubnet {
    cidr: string;
    "old-space": string;
    subnet: string;
}
export interface RemoveSpaceParam {
    "dry-run"?: boolean;
    force?: boolean;
    space: Entity;
}
export interface RemoveSpaceParams {
    "space-param": RemoveSpaceParam[];
}
export interface RemoveSpaceResult {
    bindings?: Entity[];
    constraints?: Entity[];
    "controller-settings"?: string[];
    error?: Error;
}
export interface RemoveSpaceResults {
    results: RemoveSpaceResult[];
}
export interface RenameSpaceParams {
    "from-space-tag": string;
    "to-space-tag": string;
}
export interface RenameSpacesParams {
    changes: RenameSpaceParams[];
}
export interface ShowSpaceResult {
    applications: string[];
    error?: Error;
    "machine-count": number;
    space: Space;
}
export interface ShowSpaceResults {
    results: ShowSpaceResult[];
}
export interface Space {
    error?: Error;
    id: string;
    name: string;
    subnets: Subnet[];
}
export interface Subnet {
    cidr: string;
    life: string;
    "provider-id"?: string;
    "provider-network-id"?: string;
    "provider-space-id"?: string;
    "space-tag": string;
    status?: string;
    "vlan-tag": number;
    zones: string[];
}
export interface AdditionalProperties {
    [key: string]: any;
}
/**
  API provides the spaces API facade for version 6.
*/
declare class SpacesV6 implements Facade {
    static NAME: string;
    static VERSION: number;
    NAME: string;
    VERSION: number;
    _transport: Transport;
    _info: ConnectionInfo;
    constructor(transport: Transport, info: ConnectionInfo);
    /**
      CreateSpaces creates a new Juju network space, associating the
      specified subnets with it (optional; can be empty).
    */
    createSpaces(params: CreateSpacesParams): Promise<ErrorResults>;
    /**
      ListSpaces lists all the available spaces and their associated subnets.
    */
    listSpaces(params: any): Promise<ListSpacesResults>;
    /**
      MoveSubnets ensures that the input subnets are in the input space.
    */
    moveSubnets(params: MoveSubnetsParams): Promise<MoveSubnetsResults>;
    /**
      ReloadSpaces refreshes spaces from substrate
    */
    reloadSpaces(params: any): Promise<any>;
    /**
      RemoveSpace removes a space.
      Returns SpaceResults if entities/settings are found which makes the deletion not possible.
    */
    removeSpace(params: RemoveSpaceParams): Promise<RemoveSpaceResults>;
    /**
      RenameSpace renames a space.
    */
    renameSpace(params: RenameSpacesParams): Promise<ErrorResults>;
    /**
      ShowSpace shows the spaces for a set of given entities.
    */
    showSpace(params: Entities): Promise<ShowSpaceResults>;
}
export default SpacesV6;