Volume
Table of Contents
- $createdAt : string|null
- Date/Time the volume was created.
- $driver : string|null
- Name of the volume driver used by the volume.
- $labels : array<string|int, string>|null
- User-defined key/value metadata.
- $mountpoint : string|null
- Mount path of the volume on the host.
- $name : string|null
- Name of the volume.
- $options : array<string|int, string>|null
- The driver specific options used when creating the volume.
- $scope : string|null
- The level at which the volume exists. Either `global` for cluster-wide,.
- $status : array<string|int, mixed>|null
- Low-level details about the volume, provided by the volume driver.
- $usageData : VolumeUsageData|null
- Usage details about the volume. This information is used by the.
- getCreatedAt() : string|null
- Date/Time the volume was created.
- getDriver() : string|null
- Name of the volume driver used by the volume.
- getLabels() : array<string|int, string>|null
- User-defined key/value metadata.
- getMountpoint() : string|null
- Mount path of the volume on the host.
- getName() : string|null
- Name of the volume.
- getOptions() : array<string|int, string>|null
- The driver specific options used when creating the volume.
- getScope() : string|null
- The level at which the volume exists. Either `global` for cluster-wide,.
- getStatus() : array<string|int, mixed>|null
- Low-level details about the volume, provided by the volume driver.
- getUsageData() : VolumeUsageData|null
- Usage details about the volume. This information is used by the.
- setCreatedAt() : self
- Date/Time the volume was created.
- setDriver() : self
- Name of the volume driver used by the volume.
- setLabels() : self
- User-defined key/value metadata.
- setMountpoint() : self
- Mount path of the volume on the host.
- setName() : self
- Name of the volume.
- setOptions() : self
- The driver specific options used when creating the volume.
- setScope() : self
- The level at which the volume exists. Either `global` for cluster-wide,.
- setStatus() : self
- Low-level details about the volume, provided by the volume driver.
- setUsageData() : self
- Usage details about the volume. This information is used by the.
Properties
$createdAt
Date/Time the volume was created.
protected
string|null
$createdAt
$driver
Name of the volume driver used by the volume.
protected
string|null
$driver
$labels
User-defined key/value metadata.
protected
array<string|int, string>|null
$labels
$mountpoint
Mount path of the volume on the host.
protected
string|null
$mountpoint
$name
Name of the volume.
protected
string|null
$name
$options
The driver specific options used when creating the volume.
protected
array<string|int, string>|null
$options
$scope
The level at which the volume exists. Either `global` for cluster-wide,.
protected
string|null
$scope
= 'local'
$status
Low-level details about the volume, provided by the volume driver.
protected
array<string|int, mixed>|null
$status
$usageData
Usage details about the volume. This information is used by the.
protected
VolumeUsageData|null
$usageData
Methods
getCreatedAt()
Date/Time the volume was created.
public
getCreatedAt() : string|null
Return values
string|null —getDriver()
Name of the volume driver used by the volume.
public
getDriver() : string|null
Return values
string|null —getLabels()
User-defined key/value metadata.
public
getLabels() : array<string|int, string>|null
Return values
array<string|int, string>|null —getMountpoint()
Mount path of the volume on the host.
public
getMountpoint() : string|null
Return values
string|null —getName()
Name of the volume.
public
getName() : string|null
Return values
string|null —getOptions()
The driver specific options used when creating the volume.
public
getOptions() : array<string|int, string>|null
Return values
array<string|int, string>|null —getScope()
The level at which the volume exists. Either `global` for cluster-wide,.
public
getScope() : string|null
or local for machine level.
Return values
string|null —getStatus()
Low-level details about the volume, provided by the volume driver.
public
getStatus() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —getUsageData()
Usage details about the volume. This information is used by the.
public
getUsageData() : VolumeUsageData|null
GET /system/df endpoint, and omitted in other endpoints.
Return values
VolumeUsageData|null —setCreatedAt()
Date/Time the volume was created.
public
setCreatedAt(string|null $createdAt) : self
Parameters
- $createdAt : string|null
Return values
self —setDriver()
Name of the volume driver used by the volume.
public
setDriver(string|null $driver) : self
Parameters
- $driver : string|null
Return values
self —setLabels()
User-defined key/value metadata.
public
setLabels(array<string|int, string>|null $labels) : self
Parameters
- $labels : array<string|int, string>|null
Return values
self —setMountpoint()
Mount path of the volume on the host.
public
setMountpoint(string|null $mountpoint) : self
Parameters
- $mountpoint : string|null
Return values
self —setName()
Name of the volume.
public
setName(string|null $name) : self
Parameters
- $name : string|null
Return values
self —setOptions()
The driver specific options used when creating the volume.
public
setOptions(array<string|int, string>|null $options) : self
Parameters
- $options : array<string|int, string>|null
Return values
self —setScope()
The level at which the volume exists. Either `global` for cluster-wide,.
public
setScope(string|null $scope) : self
or local for machine level.
Parameters
- $scope : string|null
Return values
self —setStatus()
Low-level details about the volume, provided by the volume driver.
public
setStatus(array<string|int, mixed>|null $status) : self
Parameters
- $status : array<string|int, mixed>|null
Return values
self —setUsageData()
Usage details about the volume. This information is used by the.
public
setUsageData(VolumeUsageData|null $usageData) : self
GET /system/df endpoint, and omitted in other endpoints.
Parameters
- $usageData : VolumeUsageData|null