1. class
  2. OpenStack
  3. ObjectStore
  4. v1
  5. Models
  6. Account

Account

class Account extends OperatorResource implements Retrievable, HasMetadata

Traits

OpenStack\ObjectStore\v1\Models\MetadataTrait
OpenStack\Common\Api\OperatorTrait

Constants

METADATA_PREFIX

Properties

$objectCount int
$bytesUsed int
$containerCount int
$metadata array
$tempUrl string

Methods

populateFromResponse (ResponseInterface $response) : AbstractResource

All models which represent an API resource should be able to be populated from a {see ResponseInterface} object.

retrieve () : void

Retrieve details of the current resource from the remote API.

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:

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:

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.

Details

View source
populateFromResponse(ResponseInterface $response)

All models which represent an API resource should be able to be populated from a {see ResponseInterface} object.

Parameters

$response ResponseInterface

Return value

AbstractResource

Example code

$abstractResource = $account->populateFromResponse($response);

View source
retrieve()

Retrieve details of the current resource from the remote API.

Return value

void

Example code

$account->retrieve();

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 The new metadata items

Return value

void

Example code

$account->mergeMetadata($metadata);

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 The new metadata items

Return value

void

Example code

$account->resetMetadata($metadata);

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 = $account->getMetadata();