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

Moby/Docker API client built using effect-ts

import * as Schema from "effect/Schema";
import * as VolumeTypeBlock from "./VolumeTypeBlock.generated.js";
import * as VolumeTypeMount from "./VolumeTypeMount.generated.js";

export class VolumeAccessMode extends Schema.Class<VolumeAccessMode>("VolumeAccessMode")(
    {
        /**
         * Scope defines the set of nodes this volume can be used on at one
         * time.
         */
        Scope: Schema.optional(Schema.Literal("single", "multi")),

        /**
         * Sharing defines the number and way that different tasks can use this
         * volume at one time.
         */
        Sharing: Schema.optional(Schema.Literal("none", "readonly", "onewriter", "all")),

        /** MountVolume defines options for using this volume as a Mount-type */
        MountVolume: Schema.optionalWith(VolumeTypeMount.VolumeTypeMount, { nullable: true }),

        /** BlockVolume defines options for using this volume as a Block-type */
        BlockVolume: Schema.optionalWith(VolumeTypeBlock.VolumeTypeBlock, { nullable: true }),
    },
    {
        identifier: "VolumeAccessMode",
        title: "volume.AccessMode",
        documentation:
            "https://github.com/moby/moby/blob/a21b1a2d12e2c01542cb191eb526d7bfad0641e3/api/types/volume/cluster_volume.go#L85-L105",
    }
) {}