the-moby-effect/src/internal/generated/VolumeInfo.generated.ts

Moby/Docker API client built using effect-ts

import * as Schema from "effect/Schema";
import * as MobySchemas from "../schemas/index.js";
import * as VolumeTopology from "./VolumeTopology.generated.js";

export class VolumeInfo extends Schema.Class<VolumeInfo>("VolumeInfo")(
    {
        /**
         * CapacityBytes is the capacity of the volume in bytes. A value of 0
         * indicates that the capacity is unknown.
         */
        CapacityBytes: Schema.optional(MobySchemas.Int64),

        /**
         * VolumeContext is the context originating from the CSI storage plugin
         * when the Volume is created.
         */
        VolumeContext: Schema.optionalWith(
            Schema.Record({
                key: Schema.String,
                value: Schema.String,
            }),
            { nullable: true }
        ),

        /**
         * VolumeID is the ID of the Volume as seen by the CSI storage plugin.
         * This is distinct from the Volume's Swarm ID, which is the ID used by
         * all of the Docker Engine to refer to the Volume. If this field is
         * blank, then the Volume has not been successfully created yet.
         */
        VolumeID: Schema.optional(Schema.String),

        /**
         * AccessibleTopology is the topology this volume is actually accessible
         * from.
         */
        AccessibleTopology: Schema.optionalWith(Schema.Array(Schema.NullOr(VolumeTopology.VolumeTopology)), {
            nullable: true,
        }),
    },
    {
        identifier: "VolumeInfo",
        title: "volume.Info",
        documentation:
            "https://github.com/moby/moby/blob/a21b1a2d12e2c01542cb191eb526d7bfad0641e3/api/types/volume/cluster_volume.go#L400-L420",
    }
) {}