Overview

Namespaces

  • OpenCloud
    • Autoscale
      • Resource
    • CloudMonitoring
      • Exception
      • Resource
    • Common
      • Collection
      • Constants
      • Exceptions
      • Http
        • Message
      • Identity
      • Log
      • Service
    • Compute
      • Constants
      • Exception
      • Resource
    • Database
      • Resource
    • DNS
      • Resource
    • LoadBalancer
      • Resource
    • ObjectStore
      • Constants
      • Exception
      • Resource
      • Upload
    • Orchestration
    • Queues
      • Exception
      • Resource
    • Volume
      • Resource
  • PHP

Classes

  • Snapshot
  • Volume
  • VolumeType
  • Overview
  • Namespace
  • Class
  • Tree
  • Download

Class Volume

The Volume class represents a single block storage volume

OpenCloud\Common\Base
Extended by OpenCloud\Common\PersistentObject
Extended by OpenCloud\Volume\Resource\Volume
Namespace: OpenCloud\Volume\Resource
Located at OpenCloud/Volume/Resource/Volume.php
Methods summary
public HttpResponse
# update( array $params = array() )

Updates an existing object

Updates an existing object

Parameters

$params
array
$params array of values to set when updating the object

Returns

HttpResponse

Throws

VolumeCreateError
if HTTP status is not Success

Api

Overrides

OpenCloud\Common\PersistentObject::update()
public string
# name( )

Returns the displayable name of the object

Returns the displayable name of the object

Can be overridden by child objects; must be overridden by child objects if the object does not have a name attribute defined.

Returns

string

Throws

NameError
if attribute 'name' is not defined

Api

Overrides

OpenCloud\Common\PersistentObject::name()
protected
# createJson( )

Returns an object for the Create() method JSON Must be overridden in a child class.

Returns an object for the Create() method JSON Must be overridden in a child class.

Throws

CreateError
if not overridden

Overrides

OpenCloud\Common\PersistentObject::createJson()
Methods inherited from OpenCloud\Common\PersistentObject
__construct(), action(), checkExtension(), create(), createUrl(), delete(), findLink(), getClient(), getMetadata(), getParent(), getService(), getUrl(), id(), jsonCollectionElement(), jsonCollectionName(), jsonName(), noCreate(), noDelete(), noUpdate(), parseResponse(), primaryKeyField(), refresh(), refreshFromLocationUrl(), region(), resourceName(), setMetadata(), setParent(), setService(), status(), updateJson(), url(), waitFor()
Methods inherited from OpenCloud\Common\Base
__call(), checkJsonError(), generateUuid(), getLogger(), getProperty(), makeResourceIteratorOptions(), populate(), propertyExists(), setLogger(), setProperty(), stripNamespace(), toCamel(), toUnderscores()
Properties summary
public mixed $id
#
public mixed $status
#
public mixed $display_name
#
public mixed $display_description
#
public mixed $size
#
public mixed $volume_type
#
public array $metadata array()
#
public mixed $availability_zone
#
public mixed $snapshot_id
#
public array $attachments array()
#
public mixed $created_at
#
protected static string $json_name 'volume'
#
protected static string $url_resource 'volumes'
#
protected array $createKeys array( 'snapshot_id', 'display_name', 'display_description', 'size', 'volume_type', 'availability_zone' )
#
protected array $associatedResources array( //'volume_type' => 'VolumeType' )
#
PHP OpenCloud API API documentation generated by ApiGen 2.8.0