@canonical/jujulib/dist/api/facades/user-secrets-drain/UserSecretsDrainV1.d.ts

Juju API client

/**
  Juju UserSecretsDrain version 1.
  This facade is available on:
    Controller-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 AccessInfo {
    role: string;
    "scope-tag": string;
    "target-tag": string;
}
export interface ChangeSecretBackendArg {
    content?: SecretContentParams;
    revision: number;
    uri: string;
}
export interface ChangeSecretBackendArgs {
    args: ChangeSecretBackendArg[];
}
export interface Error {
    code: string;
    info?: AdditionalProperties;
    message: string;
}
export interface ErrorResult {
    error?: Error;
}
export interface ErrorResults {
    results: ErrorResult[];
}
export interface GetSecretContentArg {
    label?: string;
    peek?: boolean;
    refresh?: boolean;
    uri: string;
}
export interface GetSecretContentArgs {
    args: GetSecretContentArg[];
}
export interface ListSecretResult {
    access?: AccessInfo[];
    "create-time": string;
    description?: string;
    label?: string;
    "latest-expire-time"?: string;
    "latest-revision": number;
    "next-rotate-time"?: string;
    "owner-tag": string;
    revisions: SecretRevision[];
    "rotate-policy"?: string;
    "update-time": string;
    uri: string;
    value?: SecretValueResult;
    version: number;
}
export interface ListSecretResults {
    results: ListSecretResult[];
}
export interface NotifyWatchResult {
    NotifyWatcherId: string;
    error?: Error;
}
export interface SecretBackendArgs {
    "backend-ids": string[];
    "for-drain": boolean;
}
export interface SecretBackendConfig {
    params?: AdditionalProperties;
    type: string;
}
export interface SecretBackendConfigResult {
    config?: SecretBackendConfig;
    draining: boolean;
    "model-controller": string;
    "model-name": string;
    "model-uuid": string;
}
export interface SecretBackendConfigResults {
    "active-id": string;
    results?: Record<string, SecretBackendConfigResult>;
}
export interface SecretContentParams {
    data?: Record<string, string>;
    "value-ref"?: SecretValueRef;
}
export interface SecretContentResult {
    "backend-config"?: SecretBackendConfigResult;
    content: SecretContentParams;
    error?: Error;
    "latest-revision"?: number;
}
export interface SecretContentResults {
    results: SecretContentResult[];
}
export interface SecretRevision {
    "backend-name"?: string;
    "create-time"?: string;
    "expire-time"?: string;
    revision: number;
    "update-time"?: string;
    "value-ref"?: SecretValueRef;
}
export interface SecretRevisionArg {
    "pending-delete": boolean;
    revisions: number[];
    uri: string;
}
export interface SecretValueRef {
    "backend-id": string;
    "revision-id": string;
}
export interface SecretValueResult {
    data?: Record<string, string>;
    error?: Error;
}
export interface AdditionalProperties {
    [key: string]: any;
}
/**
  SecretsDrainAPI is the implementation for the SecretsDrain facade.
*/
declare class UserSecretsDrainV1 implements Facade {
    static NAME: string;
    static VERSION: number;
    NAME: string;
    VERSION: number;
    _transport: Transport;
    _info: ConnectionInfo;
    constructor(transport: Transport, info: ConnectionInfo);
    /**
      ChangeSecretBackend updates the backend for the specified secret after migration done.
    */
    changeSecretBackend(params: ChangeSecretBackendArgs): Promise<ErrorResults>;
    /**
      GetSecretBackendConfigs gets the config needed to create a client to secret backends for the drain worker.
    */
    getSecretBackendConfigs(params: SecretBackendArgs): Promise<SecretBackendConfigResults>;
    /**
      GetSecretContentInfo returns the secret values for the specified secrets.
    */
    getSecretContentInfo(params: GetSecretContentArgs): Promise<SecretContentResults>;
    /**
      GetSecretRevisionContentInfo returns the secret values for the specified secret revisions.
    */
    getSecretRevisionContentInfo(params: SecretRevisionArg): Promise<SecretContentResults>;
    /**
      GetSecretsToDrain returns metadata for the secrets that need to be drained.
    */
    getSecretsToDrain(params: any): Promise<ListSecretResults>;
    /**
      WatchSecretBackendChanged sets up a watcher to notify of changes to the secret backend.
    */
    watchSecretBackendChanged(params: any): Promise<NotifyWatchResult>;
}
export default UserSecretsDrainV1;