Overview

Namespaces

  • OpenCloud
    • Autoscale
      • Resource
    • CDN
      • Resource
    • CloudMonitoring
      • Collection
      • 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
      • Collection
      • Enum
      • Resource
    • Networking
      • Resource
    • ObjectStore
      • Constants
      • Enum
      • Exception
      • Resource
      • Upload
    • Orchestration
      • Resource
    • Queues
      • Collection
      • Exception
      • Resource
    • Volume
      • Resource
  • PHP

Classes

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

Class Volume

The Volume class represents a single block storage volume

OpenCloud\Common\Base
Extended by OpenCloud\Common\Resource\BaseResource
Extended by OpenCloud\Common\Resource\PersistentResource
Extended by OpenCloud\Volume\Resource\Volume
Namespace: OpenCloud\Volume\Resource
Located at OpenCloud/Volume/Resource/Volume.php
Methods summary
public Guzzle\Http\Message\Response
# update( array $params = array() )

Update a resource

Update a resource

Parameters

$params

Returns

Guzzle\Http\Message\Response
\Guzzle\Http\Message\Response

Overrides

OpenCloud\Common\Resource\PersistentResource::update()
public Guzzle\Http\Message\Response
# rename( array $params = array() )

Rename either the display_description or the display_name properties

Rename either the display_description or the display_name properties

Parameters

$params

Returns

Guzzle\Http\Message\Response
\Guzzle\Http\Message\Response

Throws

InvalidArgumentException
\InvalidArgumentException
protected object
# createJson( )

Provides JSON for create request body

Provides JSON for create request body

Returns

object
object

Throws

RuntimeException
\RuntimeException

Overrides

OpenCloud\Common\Resource\PersistentResource::createJson()
Methods inherited from OpenCloud\Common\Resource\PersistentResource
checkExtension(), create(), delete(), generateJsonPatch(), getAlias(), getUpdateablePropertiesAsArray(), noCreate(), noDelete(), noUpdate(), recursivelyAliasPropertyValue(), refresh(), refreshFromLocationUrl(), refreshFromParent(), updateJson(), waitFor()
Methods inherited from OpenCloud\Common\Resource\BaseResource
__construct(), findLink(), getClient(), getMetadata(), getParent(), getService(), getUrl(), jsonCollectionElement(), jsonCollectionName(), jsonName(), parseResponse(), primaryKeyField(), resourceName(), setMetadata(), setParent(), setService()
Methods inherited from OpenCloud\Common\Base
__call(), checkJsonError(), generateUuid(), getInstance(), getJsonHeader(), getLogger(), getPatchHeaders(), getProperty(), hasLogger(), makeResourceIteratorOptions(), populate(), propertyExists(), setLogger(), setProperty(), stripNamespace(), toCamel(), toUnderscores()
Constants inherited from OpenCloud\Common\Base
PATCH_CONTENT_TYPE
Properties summary
public mixed $id
#
public mixed $status
#
public mixed $display_name
#
public mixed $display_description
#
public mixed $size
#
public mixed $volume_type
#
public OpenCloud\Common\Metadata $metadata
#array()
public mixed $availability_zone
#
public mixed $snapshot_id
#
public array $attachments
#array()
public mixed $created_at
#
public mixed $source_volid
#
public mixed $imageRef
#
public mixed $bootable
#
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', 'metadata', 'source_volid', 'bootable', 'imageRef' )
protected array $associatedResources
#array()
Properties inherited from OpenCloud\Common\Resource\BaseResource
$parent, $service
Properties inherited from OpenCloud\Common\Base
$aliases
API documentation generated by ApiGen 2.8.0