Interface Volume

Volume

interface Volume {
    CreatedAt?: string;
    Driver: string;
    Labels: {
        [key: string]: string;
    };
    Mountpoint: string;
    Name: string;
    Options: {
        [key: string]: string;
    };
    Scope: VolumeScopeEnum;
    Status?: {
        [key: string]: object;
    };
    UsageData?: null | VolumeUsageData;
}

Properties

CreatedAt? Driver Labels Mountpoint Name Options Scope Status? UsageData?

Properties

OptionalCreatedAt

CreatedAt?: string

Date/Time the volume was created.

Driver

Driver: string

Name of the volume driver used by the volume.

Labels

Labels: {
    [key: string]: string;
}

User-defined key/value metadata.

Mountpoint

Mountpoint: string

Mount path of the volume on the host.

Name

Name: string

Name of the volume.

Options

Options: {
    [key: string]: string;
}

The driver specific options used when creating the volume.

Scope

Scope: VolumeScopeEnum

The level at which the volume exists. Either global for cluster-wide, or local for machine level.

OptionalStatus

Status?: {
    [key: string]: object;
}

Low-level details about the volume, provided by the volume driver. Details are returned as a map with key/value pairs: {\"key\":\"value\",\"key2\":\"value2\"}. The Status field is optional, and is omitted if the volume driver does not support this feature.

OptionalUsageData

UsageData?: null | VolumeUsageData

Settings

Member Visibility

On This Page

Properties