/* generated using openapi-typescript-codegen -- do no edit */
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */

import type { MountType } from './MountType';

export type Mount = {
    /**
     * Container path.
     */
    Target?: string;
    /**
     * Mount source (e.g. a volume name, a host path). The source cannot be
     * specified when using `Type=tmpfs`. For `Type=bind`, the source path
     * must either exist, or the `CreateMountpoint` must be set to `true` to
     * create the source path on the host if missing.
     *
     * For `Type=npipe`, the pipe must exist prior to creating the container.
     */
    Source?: string;
    /**
     * The mount type. Available types:
     *
     * - `bind` Mounts a file or directory from the host into the container. The `Source` must exist prior to creating the container.
     * - `cluster` a Swarm cluster volume
     * - `image` Mounts an image.
     * - `npipe` Mounts a named pipe from the host into the container. The `Source` must exist prior to creating the container.
     * - `tmpfs` Create a tmpfs with the given options. The mount `Source` cannot be specified for tmpfs.
     * - `volume` Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are **not** removed when the container is removed.
     *
     */
    Type?: MountType;
    /**
     * Whether the mount should be read-only.
     */
    ReadOnly?: boolean;
    /**
     * The consistency requirement for the mount: `default`, `consistent`, `cached`, or `delegated`.
     */
    Consistency?: string;
    /**
     * Optional configuration for the `bind` type.
     */
    BindOptions?: {
        /**
         * A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`.
         */
        Propagation?: 'private' | 'rprivate' | 'shared' | 'rshared' | 'slave' | 'rslave';
        /**
         * Disable recursive bind mount.
         */
        NonRecursive?: boolean;
        /**
         * Create mount point on host if missing
         */
        CreateMountpoint?: boolean;
        /**
         * Make the mount non-recursively read-only, but still leave the mount recursive
         * (unless NonRecursive is set to `true` in conjunction).
         *
         * Added in v1.44, before that version all read-only mounts were
         * non-recursive by default. To match the previous behaviour this
         * will default to `true` for clients on versions prior to v1.44.
         *
         */
        ReadOnlyNonRecursive?: boolean;
        /**
         * Raise an error if the mount cannot be made recursively read-only.
         */
        ReadOnlyForceRecursive?: boolean;
    };
    /**
     * Optional configuration for the `volume` type.
     */
    VolumeOptions?: {
        /**
         * Populate volume with data from the target.
         */
        NoCopy?: boolean;
        /**
         * User-defined key/value metadata.
         */
        Labels?: Record<string, string>;
        /**
         * Map of driver specific options
         */
        DriverConfig?: {
            /**
             * Name of the driver to use to create the volume.
             */
            Name?: string;
            /**
             * key/value map of driver specific options.
             */
            Options?: Record<string, string>;
        };
        /**
         * Source path inside the volume. Must be relative without any back traversals.
         */
        Subpath?: string;
    };
    /**
     * Optional configuration for the `image` type.
     */
    ImageOptions?: {
        /**
         * Source path inside the image. Must be relative without any back traversals.
         */
        Subpath?: string;
    };
    /**
     * Optional configuration for the `tmpfs` type.
     */
    TmpfsOptions?: {
        /**
         * The size for the tmpfs mount in bytes.
         */
        SizeBytes?: number;
        /**
         * The permission mode for the tmpfs mount in an integer.
         * The value must not be in octal format (e.g. 755) but rather
         * the decimal representation of the octal value (e.g. 493).
         *
         */
        Mode?: number;
        /**
         * The options to be passed to the tmpfs mount. An array of arrays.
         * Flag options should be provided as 1-length arrays. Other types
         * should be provided as as 2-length arrays, where the first item is
         * the key and the second the value.
         *
         */
        Options?: Array<Array<string>>;
    };
};