Overview

Namespaces

  • OpenCloud
    • Autoscale
      • Resource
    • CloudMonitoring
      • Exception
      • Resource
    • Common
      • Collection
      • Constants
      • Exceptions
      • Http
        • Message
      • Log
      • Resource
      • Service
    • Compute
      • Constants
      • Exception
      • Resource
    • Database
      • Resource
    • DNS
      • Collection
      • Resource
    • Identity
      • Constants
      • Resource
    • Image
      • Enum
      • Resource
        • JsonPatch
        • Schema
    • LoadBalancer
      • Enum
      • 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 implements OpenCloud\Common\Service\ServiceInterface
Extended by OpenCloud\Common\Service\CatalogService
Extended by OpenCloud\Common\Service\NovaService
Extended by OpenCloud\Volume\Service
Namespace: OpenCloud\Volume
Located at OpenCloud/Volume/Service.php
Methods summary
public OpenCloud\Volume\Resource\Volume
# volume( string $id = null )

Returns a Volume object

Returns a Volume object

Parameters

$id
string
$id the Volume ID

Returns

OpenCloud\Volume\Resource\Volume
public OpenCloud\Common\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
$filter array of filter key/value pairs

Returns

OpenCloud\Common\Collection
public OpenCloud\Volume\Resource\Volume
# volumeType( string $id = null )

Returns a VolumeType object

Returns a VolumeType object

Parameters

$id
string
$id the VolumeType ID

Returns

OpenCloud\Volume\Resource\Volume
public OpenCloud\Common\Collection
# volumeTypeList( array $filter = array() )

Returns a Collection of VolumeType objects

Returns a Collection of VolumeType objects

Parameters

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

Returns

OpenCloud\Common\Collection
public OpenCloud\Volume\Resource\Snapshot
# snapshot( null $id = null )

Returns a Snapshot object associated with this volume

Returns a Snapshot object associated with this volume

Parameters

$id
null
$id

Returns

OpenCloud\Volume\Resource\Snapshot
public OpenCloud\Common\Collection
# snapshotList( array $filter = array() )

Returns a Collection of Snapshot objects

Returns a Collection of Snapshot objects

Parameters

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

Returns

OpenCloud\Common\Collection
Methods inherited from OpenCloud\Common\Service\NovaService
flavor(), flavorList(), loadNamespaces()
Methods inherited from OpenCloud\Common\Service\CatalogService
__construct(), getBaseUrl(), getExtensions(), getName(), getRegion(), getType(), getUrl(), getUrlType(), limits()
Methods inherited from OpenCloud\Common\Service\AbstractService
collection(), getClient(), getCurrentNamespace(), getEndpoint(), getNamespaces(), getResources(), resolveResourceClass(), resource(), resourceList(), setClient(), setEndpoint()
Methods inherited from OpenCloud\Common\Base
__call(), checkJsonError(), generateUuid(), getInstance(), getJsonHeader(), 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\CatalogService
DEFAULT_URL_TYPE
Properties inherited from OpenCloud\Common\Service\CatalogService
$regionless
Properties inherited from OpenCloud\Common\Service\AbstractService
$client, $endpoint, $namespaces, $resources
Properties inherited from OpenCloud\Common\Base
$aliases
PHP OpenCloud API API documentation generated by ApiGen 2.8.0