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

  • Service
  • Overview
  • Namespace
  • Class
  • Tree
  • Download

Class Service

NovaService serves as an additional abstraction for particular OpenStack services that exhibit shared functionality.

OpenCloud\Common\Base
Extended by OpenCloud\Common\Service\AbstractService
Extended by OpenCloud\Common\Service\NovaService
Extended by OpenCloud\Volume\Service
Namespace: OpenCloud\Volume
Located at OpenCloud/Volume/Service.php
Methods summary
public VolumeService\Volume
# volume( string $id = null )

Returns a Volume object

Returns a Volume object

Parameters

$id
string
$id the Volume ID

Returns

VolumeService\Volume

Api

public Collection
# volumeList( boolean $details = true, array $filter = array() )

Returns a Collection of Volume objects

Returns a Collection of Volume objects

Parameters

$details
boolean
$details if TRUE, return all details
$filter
array
$filters array of filter key/value pairs

Returns

Collection

Api

public VolumeService\Volume
# volumeType( string $id = null )

Returns a VolumeType object

Returns a VolumeType object

Parameters

$id
string
$id the VolumeType ID

Returns

VolumeService\Volume

Api

public Collection
# volumeTypeList( array $filter = array() )

Returns a Collection of VolumeType objects

Returns a Collection of VolumeType objects

Parameters

$filter
array
$filters array of filter key/value pairs

Returns

Collection

Api

public Snapshot
# snapshot( mixed $id = null )

returns a Snapshot object associated with this volume

returns a Snapshot object associated with this volume

Returns

Snapshot
public Collection
# snapshotList( boolean $filter = array() )

Returns a Collection of Snapshot objects

Returns a Collection of Snapshot objects

Parameters

$filter
boolean
$detail TRUE to return full details

Returns

Collection

Api

Methods inherited from OpenCloud\Common\Service\NovaService
flavor(), flavorList(), loadNamespaces()
Methods inherited from OpenCloud\Common\Service\AbstractService
__construct(), collection(), getBaseUrl(), getClient(), getCurrentNamespace(), getEndpoint(), getExtensions(), getName(), getRegion(), getResources(), getType(), getUrl(), getUrlType(), limits(), namespaces(), resolveResourceClass(), resource(), resourceList(), setClient()
Methods inherited from OpenCloud\Common\Base
__call(), checkJsonError(), generateUuid(), getLogger(), getProperty(), makeResourceIteratorOptions(), populate(), propertyExists(), setLogger(), setProperty(), stripNamespace(), toCamel(), toUnderscores()
Constants summary
string DEFAULT_TYPE 'volume'
#
string DEFAULT_NAME 'cloudBlockStorage'
#
Constants inherited from OpenCloud\Common\Service\AbstractService
DEFAULT_REGION, DEFAULT_URL_TYPE
Properties inherited from OpenCloud\Common\Service\AbstractService
$client, $namespaces, $resources
PHP OpenCloud API API documentation generated by ApiGen 2.8.0