the-moby-effect/dist/dts/internal/endpoints/configs.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 { SwarmConfig, SwarmConfigCreateResponse, SwarmConfigSpec } from "../generated/index.js";
/**
 * @since 1.0.0
 * @category Errors
 */
export declare const ConfigsErrorTypeId: unique symbol;
/**
 * @since 1.0.0
 * @category Errors
 */
export type ConfigsErrorTypeId = typeof ConfigsErrorTypeId;
/**
 * @since 1.0.0
 * @category Errors
 */
export declare const isConfigsError: (u: unknown) => u is ConfigsError;
declare const ConfigsError_base: new <A extends Record<string, any>>(args: import("effect/Types").Simplify<A>) => import("effect/Cause").YieldableError & Record<typeof ConfigsErrorTypeId, typeof ConfigsErrorTypeId> & {
    readonly _tag: "ConfigsError";
} & Readonly<A>;
/**
 * @since 1.0.0
 * @category Errors
 */
export declare class ConfigsError extends ConfigsError_base<{
    method: string;
    cause: ParseResult.ParseError | HttpClientError.HttpClientError | HttpBody.HttpBodyError | unknown;
}> {
    get message(): string;
}
declare const Configs_base: Effect.Service.Class<Configs, "@the-moby-effect/endpoints/Configs", {
    readonly accessors: false;
    readonly dependencies: readonly [];
    readonly effect: Effect.Effect<{
        list: (options?: {
            readonly filters?: {
                id?: string | undefined;
                label?: Record<string, string> | undefined;
                name?: string | undefined;
                names?: string | undefined;
            };
        } | undefined) => Effect.Effect<ReadonlyArray<SwarmConfig>, ConfigsError, never>;
        create: (options: typeof SwarmConfigSpec.Encoded) => Effect.Effect<Readonly<SwarmConfigCreateResponse>, ConfigsError, never>;
        delete: (id: string) => Effect.Effect<void, ConfigsError, never>;
        inspect: (id: string) => Effect.Effect<Readonly<SwarmConfig>, ConfigsError, never>;
        update: (id: string, options: {
            /**
             * The spec of the config to update. Currently, only the Labels
             * field can be updated. All other fields must remain unchanged
             * from the ConfigInspect response values.
             */
            readonly spec: SwarmConfigSpec;
            /**
             * The version number of the config object being updated. This
             * is required to avoid conflicting writes.
             */
            readonly version: number;
        }) => Effect.Effect<void, ConfigsError, never>;
    }, never, HttpClient.HttpClient>;
}>;
/**
 * Configs are application configurations that can be used by services. Swarm
 * mode must be enabled for these endpoints to work.
 *
 * @since 1.0.0
 * @category Services
 * @see https://docs.docker.com/reference/api/engine/latest/#tag/Config
 */
export declare class Configs extends Configs_base {
}
/**
 * Configs are application configurations 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/Config
 */
export declare const ConfigsLayer: Layer.Layer<Configs, never, HttpClient.HttpClient>;
export {};
//# sourceMappingURL=configs.d.ts.map