github.com/docker/docker@v299999999.0.0-20200612211812-aaf470eca7b5+incompatible/api/types/volume.go (about)

     1  package types
     2  
     3  // This file was generated by the swagger tool.
     4  // Editing this file might prove futile when you re-run the swagger generate command
     5  
     6  // Volume volume
     7  // swagger:model Volume
     8  type Volume struct {
     9  
    10  	// Date/Time the volume was created.
    11  	CreatedAt string `json:"CreatedAt,omitempty"`
    12  
    13  	// Name of the volume driver used by the volume.
    14  	// Required: true
    15  	Driver string `json:"Driver"`
    16  
    17  	// User-defined key/value metadata.
    18  	// Required: true
    19  	Labels map[string]string `json:"Labels"`
    20  
    21  	// Mount path of the volume on the host.
    22  	// Required: true
    23  	Mountpoint string `json:"Mountpoint"`
    24  
    25  	// Name of the volume.
    26  	// Required: true
    27  	Name string `json:"Name"`
    28  
    29  	// The driver specific options used when creating the volume.
    30  	//
    31  	// Required: true
    32  	Options map[string]string `json:"Options"`
    33  
    34  	// The level at which the volume exists. Either `global` for cluster-wide,
    35  	// or `local` for machine level.
    36  	//
    37  	// Required: true
    38  	Scope string `json:"Scope"`
    39  
    40  	// Low-level details about the volume, provided by the volume driver.
    41  	// Details are returned as a map with key/value pairs:
    42  	// `{"key":"value","key2":"value2"}`.
    43  	//
    44  	// The `Status` field is optional, and is omitted if the volume driver
    45  	// does not support this feature.
    46  	//
    47  	Status map[string]interface{} `json:"Status,omitempty"`
    48  
    49  	// usage data
    50  	UsageData *VolumeUsageData `json:"UsageData,omitempty"`
    51  }
    52  
    53  // VolumeUsageData Usage details about the volume. This information is used by the
    54  // `GET /system/df` endpoint, and omitted in other endpoints.
    55  //
    56  // swagger:model VolumeUsageData
    57  type VolumeUsageData struct {
    58  
    59  	// The number of containers referencing this volume. This field
    60  	// is set to `-1` if the reference-count is not available.
    61  	//
    62  	// Required: true
    63  	RefCount int64 `json:"RefCount"`
    64  
    65  	// Amount of disk space used by the volume (in bytes). This information
    66  	// is only available for volumes created with the `"local"` volume
    67  	// driver. For volumes created with other volume drivers, this field
    68  	// is set to `-1` ("not available")
    69  	//
    70  	// Required: true
    71  	Size int64 `json:"Size"`
    72  }