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

Object

class Object extends OperatorResource implements Creatable, Deletable, HasMetadata

Traits

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

Constants

METADATA_PREFIX

Properties

$containerName string
$name string
$hash string
$contentType string
$contentLength int
$lastModified string
$metadata array

Methods

populateFromResponse (ResponseInterface $response) : AbstractResource

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

getPublicUri () : Uri

Retrieves the public URI for this resource.

create (array $data) : $this

Create a new resource according to the configuration set in the options.

retrieve ()

{@inheritdoc}

download (array $data = array()) : StreamInterface

This call will perform a GET HTTP request for the given object and return back its content in the form of a Guzzle Stream object. Downloading an object will transfer all of the content for an object, and is therefore distinct from fetching its metadata (a HEAD request). The body of an object is not fetched by default to improve performance when handling large objects.

delete () : void

Permanently delete this resource.

copy (array $options)

No description

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 = $object->populateFromResponse($response);

View source
getPublicUri()

Retrieves the public URI for this resource.

Return value

Uri

Example code

$uri = $object->getPublicUri();

View source
create(array $data)

Create a new resource according to the configuration set in the options.

Parameters

$data array {see \OpenStack\ObjectStore\v1\Api::putObject}

Return value

$this

Example code

$models = $object->create($data);

View source
retrieve()

{@inheritdoc}

Example code

$object->retrieve();

View source
download(array $data = array())

This call will perform a GET HTTP request for the given object and return back its content in the form of a Guzzle Stream object. Downloading an object will transfer all of the content for an object, and is therefore distinct from fetching its metadata (a HEAD request). The body of an object is not fetched by default to improve performance when handling large objects.

Parameters

$data array {see \OpenStack\ObjectStore\v1\Api::getObject}

Return value

StreamInterface

Example code

$streamInterface = $object->download($data);

View source
delete()

Permanently delete this resource.

Return value

void

Example code

$object->delete();

View source
copy(array $options)

Parameters

$options array {see \OpenStack\ObjectStore\v1\Api::copyObject}

Example code

$object->copy($options);

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

$object->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

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