1. class
  2. OpenStack
  3. Compute
  4. v2
  5. Models
  6. Image

Image

class Image extends OperatorResource implements Listable, Retrievable, Deletable, HasMetadata

Represents a Compute v2 Image

Traits

OpenStack\Common\Api\OperatorTrait

Properties

$id string
$links
$metadata array
$minDisk int
$minRam int
$name string
$progress string
$status string
$created DateTimeImmutable
$updated DateTimeImmutable

Methods

retrieve () : void

Retrieve details of the current resource from the remote API.

delete () : void

Permanently delete this resource.

getMetadata () : array

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.

resetMetadata (array $metadata) : void

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:

mergeMetadata (array $metadata) : void

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:

getMetadataItem (string $key) : mixed

Retrieve the value for a specific metadata key.

deleteMetadataItem (string $key)

Remove a specific metadata key.

parseMetadata (ResponseInterface $response) : array

Extracts metadata from a response object and returns it in the form of an associative array.

Details

View source
retrieve()

Retrieve details of the current resource from the remote API.

Return value

void

Example code

$image->retrieve();

View source
delete()

Permanently delete this resource.

Return value

void

Example code

$image->delete();

View source
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.

Return value

array

Example code

$array = $image->getMetadata();

View source
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

Parameters

$metadata array {see \OpenStack\Compute\v2\Api::putImageMetadata}

Return value

void

Example code

$image->resetMetadata($metadata);

View source
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.

Parameters

$metadata array {see \OpenStack\Compute\v2\Api::postImageMetadata}

Return value

void

Example code

$image->mergeMetadata($metadata);

View source
getMetadataItem(string $key)

Retrieve the value for a specific metadata key.

Parameters

$key string {see \OpenStack\Compute\v2\Api::getImageMetadataKey}

Return value

mixed

Example code

$mixed = $image->getMetadataItem($key);

View source
deleteMetadataItem(string $key)

Remove a specific metadata key.

Parameters

$key string {see \OpenStack\Compute\v2\Api::deleteImageMetadataKey}

Example code

$image->deleteMetadataItem($key);

View source
parseMetadata(ResponseInterface $response)

Extracts metadata from a response object and returns it in the form of an associative array.

Parameters

$response ResponseInterface

Return value

array

Example code

$array = $image->parseMetadata($response);