@canonical/jujulib/dist/api/facades/payloads-hook-context/PayloadsHookContextV1.d.ts

Juju API client

/**
  Juju PayloadsHookContext 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 Entities {
    entities: Entity[];
}
export interface Entity {
    tag: string;
}
export interface Error {
    code: string;
    info?: AdditionalProperties;
    message: string;
}
export interface LookUpPayloadArg {
    id: string;
    name: string;
}
export interface LookUpPayloadArgs {
    args: LookUpPayloadArg[];
}
export interface Payload {
    class: string;
    id: string;
    labels: string[];
    machine: string;
    status: string;
    type: string;
    unit: string;
}
export interface PayloadResult {
    Entity: Entity;
    error?: Error;
    "not-found": boolean;
    payload: Payload;
    tag: string;
}
export interface PayloadResults {
    results: PayloadResult[];
}
export interface SetPayloadStatusArg {
    Entity: Entity;
    status: string;
    tag: string;
}
export interface SetPayloadStatusArgs {
    args: SetPayloadStatusArg[];
}
export interface TrackPayloadArgs {
    payloads: Payload[];
}
export interface AdditionalProperties {
    [key: string]: any;
}
/**
  UnitFacade serves payload-specific API methods.
*/
declare class PayloadsHookContextV1 implements Facade {
    static NAME: string;
    static VERSION: number;
    NAME: string;
    VERSION: number;
    _transport: Transport;
    _info: ConnectionInfo;
    constructor(transport: Transport, info: ConnectionInfo);
    /**
      List builds the list of payload being tracked for
      the given unit and IDs. If no IDs are provided then all tracked
      payloads for the unit are returned.
    */
    list(params: Entities): Promise<PayloadResults>;
    /**
      LookUp identifies the payload with the provided name and raw ID.
    */
    lookUp(params: LookUpPayloadArgs): Promise<PayloadResults>;
    /**
      SetStatus sets the raw status of a payload.
    */
    setStatus(params: SetPayloadStatusArgs): Promise<PayloadResults>;
    /**
      Track stores a payload to be tracked in state.
    */
    track(params: TrackPayloadArgs): Promise<PayloadResults>;
    /**
      Untrack marks the identified payload as no longer being tracked.
    */
    untrack(params: Entities): Promise<PayloadResults>;
}
export default PayloadsHookContextV1;