the-moby-effect/dist/dts/internal/endpoints/secrets.d.ts

Moby/Docker API client built using effect-ts

import type * as HttpBody from "@effect/platform/HttpBody";
import type * as HttpClientError from "@effect/platform/HttpClientError";
import type * as Layer from "effect/Layer";
import type * as ParseResult from "effect/ParseResult";
import * as HttpClient from "@effect/platform/HttpClient";
import * as Effect from "effect/Effect";
import { SwarmSecret, SwarmSecretCreateResponse, SwarmSecretSpec } from "../generated/index.js";
/**
 * @since 1.0.0
 * @category Errors
 */
export declare const SecretsErrorTypeId: unique symbol;
/**
 * @since 1.0.0
 * @category Errors
 */
export type SecretsErrorTypeId = typeof SecretsErrorTypeId;
/**
 * @since 1.0.0
 * @category Errors
 */
export declare const isSecretsError: (u: unknown) => u is SecretsError;
declare const SecretsError_base: new <A extends Record<string, any>>(args: import("effect/Types").Simplify<A>) => import("effect/Cause").YieldableError & Record<typeof SecretsErrorTypeId, typeof SecretsErrorTypeId> & {
    readonly _tag: "SecretsError";
} & Readonly<A>;
/**
 * @since 1.0.0
 * @category Errors
 */
export declare class SecretsError extends SecretsError_base<{
    method: string;
    cause: ParseResult.ParseError | HttpClientError.HttpClientError | HttpBody.HttpBodyError | unknown;
}> {
    get message(): string;
}
declare const Secrets_base: Effect.Service.Class<Secrets, "@the-moby-effect/endpoints/Secrets", {
    readonly accessors: false;
    readonly dependencies: readonly [];
    readonly effect: Effect.Effect<{
        list: (options?: {
            readonly filters?: Record<string, string | Array<string>>;
        } | undefined) => Effect.Effect<Readonly<Array<SwarmSecret>>, SecretsError, never>;
        create: (data: typeof SwarmSecretSpec.Encoded) => Effect.Effect<Readonly<SwarmSecretCreateResponse>, SecretsError, never>;
        delete: (id: string) => Effect.Effect<void, SecretsError, never>;
        inspect: (id: string) => Effect.Effect<Readonly<SwarmSecret>, SecretsError, never>;
        update: (id: string, options: {
            readonly spec: SwarmSecretSpec;
            readonly version: number;
        }) => Effect.Effect<void, SecretsError, never>;
    }, never, HttpClient.HttpClient>;
}>;
/**
 * Secrets are sensitive data that can be used by services. Swarm mode must be
 * enabled for these endpoints to work.
 *
 * @since 1.0.0
 * @category Tags
 * @see https://docs.docker.com/reference/api/engine/latest/#tag/Secret
 */
export declare class Secrets extends Secrets_base {
}
/**
 * Secrets are sensitive data that can be used by services. Swarm mode must be
 * enabled for these endpoints to work.
 *
 * @since 1.0.0
 * @category Layers
 * @see https://docs.docker.com/reference/api/engine/latest/#tag/Secret
 */
export declare const SecretsLayer: Layer.Layer<Secrets, never, HttpClient.HttpClient>;
export {};
//# sourceMappingURL=secrets.d.ts.map