Overview

Namespaces

  • None
  • OpenCloud
    • Autoscale
      • Resource
    • CloudMonitoring
      • Exception
      • Resource
    • Common
      • Exceptions
      • Log
      • Request
        • Response
    • Compute
    • Database
    • DNS
    • LoadBalancer
      • Resources
    • ObjectStore
      • Resource
    • Orchestration
    • Volume
  • PHP

Classes

  • Service
  • 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\Volume
Namespace: OpenCloud\Volume
Author: Glen Campbell <glen.campbell@rackspace.com>
Api
Located at OpenCloud/Volume/Volume.php
Methods summary
public
# Update( mixed $params = array() )

Always throws an error; updates are not permitted

Always throws an error; updates are not permitted

Throws

OpenCloud\UpdateError
always
public string
# Name( )

returns the name of the volume

returns the name of the volume

Returns

string

Api

protected stdClass
# CreateJson( )

Creates the JSON object for the Create() method

Creates the JSON object for the Create() method

Returns

stdClass
Methods inherited from OpenCloud\Common\PersistentObject
__construct(), __set(), action(), checkExtension(), create(), createJson(), createUrl(), customAction(), delete(), findLink(), getParent(), getService(), id(), jsonCollectionElement(), jsonCollectionName(), jsonName(), name(), noCreate(), noDelete(), noUpdate(), parent(), primaryKeyField(), refresh(), region(), resourceName(), service(), setParent(), setService(), status(), update(), updateJson(), url(), waitFor()
Methods inherited from OpenCloud\Common\Base
checkJsonError(), getHttpRequestObject(), getLogger(), makeQueryString(), populate(), setLogger(), setProperty()
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'
#
PHP OpenCloud API API documentation generated by ApiGen 2.8.0