Volume
class Volume extends OperatorResource implements Creatable, Listable, Updateable, Deletable, Retrievable, HasMetadata
Traits
Properties
$id | string | |
$size | int | |
$status | string | |
$name | string | |
$attachments | array | |
$availabilityZone | string | |
$createdAt | DateTimeImmutable | |
$description | string | |
$volumeTypeName | string | |
$snapshotId | string | |
$sourceVolumeId | string | |
$tenantId | string | |
$host | string | |
$metadata | array | |
$volumeImageMetadata | array |
Methods
All models which represent an API resource should be able to be populated from a {see ResponseInterface} object.
Retrieve details of the current resource from the remote API.
Update the current resource with the configuration set out in the user options.
Permanently delete this resource.
Retrieves the metadata for the resource in the form of an associative array or hash. Each key represents the metadata item's name, and each value represents the metadata item's remote value.
Merges a set of new values with those which already exist (on the remote API) for a resource. For example, if the resource has this metadata already set:
Replaces all of the existing metadata items for a resource with a new set of values. Any metadata items which are not provided in the call are removed from the resource. For example, if the resource has this metadata already set:
Extracts metadata from a response object and returns it in the form of an associative array.
Details
populateFromResponse(ResponseInterface $response)
All models which represent an API resource should be able to be populated from a {see ResponseInterface} object.
getMetadata()
Retrieves the metadata for the resource in the form of an associative array or hash. Each key represents the metadata item's name, and each value represents the metadata item's remote value.
mergeMetadata(array $metadata)
Merges a set of new values with those which already exist (on the remote API) for a resource. For example, if the resource has this metadata already set:
Foo: val1 Bar: val2
and mergeMetadata(['Foo' => 'val3', 'Baz' => 'val4']); is called, then the resource will have the following metadata:
Foo: val3 Bar: val2 Baz: val4
You will notice that any metadata items which are not specified in the call are preserved.
resetMetadata(array $metadata)
Replaces all of the existing metadata items for a resource with a new set of values. Any metadata items which are not provided in the call are removed from the resource. For example, if the resource has this metadata already set:
Foo: val1 Bar: val2
and resetMetadata(['Foo' => 'val3', 'Baz' => 'val4']); is called, then the resource will have the following metadata:
Foo: val3 Baz: val4