@canonical/jujulib
Version:
Juju API client
69 lines (67 loc) • 1.92 kB
TypeScript
/**
Juju Singular version 2.
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 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 SingularClaim {
"claimant-tag": string;
duration: number;
"entity-tag": string;
}
export interface SingularClaims {
claims: SingularClaim[];
}
export interface AdditionalProperties {
[key: string]: any;
}
/**
Facade allows controller machines to request exclusive rights to administer
some specific model or controller for a limited time.
*/
declare class SingularV2 implements Facade {
static NAME: string;
static VERSION: number;
NAME: string;
VERSION: number;
_transport: Transport;
_info: ConnectionInfo;
constructor(transport: Transport, info: ConnectionInfo);
/**
Claim makes the supplied singular-controller lease requests. (In practice,
any requests not for the connection's model or controller, or not on behalf
of the connected ModelManager machine, will be rejected.)
*/
claim(params: SingularClaims): Promise<ErrorResults>;
/**
Wait waits for the singular-controller lease to expire for all supplied
entities. (In practice, any requests that do not refer to the connection's
model or controller will be rejected.)
*/
wait(params: Entities): Promise<ErrorResults>;
}
export default SingularV2;