OpenCloud/Volume/Service.php

Properties

Description

The OpenStack Cinder (Volume) service

Classes

Service

Properties

 
 
No 
No 

Description

Nova is an abstraction layer for the OpenStack compute service.
Nova is used as a basis for several products, including Compute services as well as Rackspace's Cloud Databases. This class is, in essence, a vehicle for sharing common code between those other classes.

Methods

Snapshot, SnapshotList, Volume, VolumeList, VolumeType, VolumeTypeList, __construct,

Snapshot(   $id = null, ) : \OpenCloud\Volume\Snapshot

Description

returns a Snapshot object associated with this volume

Arguments

Name Type Description Default
$id n/a null

Return value

Type Description
\OpenCloud\Volume\Snapshot

SnapshotList(   $filter = array(), ) : \OpenCloud\Volume\Collection

Description

Returns a Collection of Snapshot objects

Arguments

Name Type Description Default
$filter n/a array()

Return value

Type Description
\OpenCloud\Volume\Collection

Tags

Name Description
api

Volume( string   $id = null, ) : \OpenCloud\Volume\VolumeService\Volume

Description

Returns a Volume object

Arguments

Name Type Description Default
$id string

the Volume ID

null

Return value

Type Description
\OpenCloud\Volume\VolumeService\Volume

Tags

Name Description
api

VolumeList( boolean   $details = true,   $filter = array(), ) : \OpenCloud\Volume\Collection

Description

Returns a Collection of Volume objects

Arguments

Name Type Description Default
$details boolean

if TRUE, return all details

true
$filter n/a array()

Return value

Type Description
\OpenCloud\Volume\Collection

Tags

Name Description
api

VolumeType( string   $id = null, ) : \OpenCloud\Volume\VolumeService\Volume

Description

Returns a VolumeType object

Arguments

Name Type Description Default
$id string

the VolumeType ID

null

Return value

Type Description
\OpenCloud\Volume\VolumeService\Volume

Tags

Name Description
api

VolumeTypeList(   $filter = array(), ) : \OpenCloud\Volume\Collection

Description

Returns a Collection of VolumeType objects

Arguments

Name Type Description Default
$filter n/a array()

Return value

Type Description
\OpenCloud\Volume\Collection

Tags

Name Description
api

__construct(   $connection,   $name,   $region,   $urltype, ) : n/a

Description

creates the VolumeService object

Arguments

Name Type Description Default
$connection n/a
$name n/a
$region n/a
$urltype n/a

Return value

Type Description
n/a n/a
Documentation was generated by phpDocumentor 2.0.0b6 .

Namespaces

Packages