github.com/rumpl/bof@v23.0.0-rc.2+incompatible/api/types/volume/volume.go (about)

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