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

  • Flavor
  • Image
  • Network
  • Server
  • ServerMetadata
  • Service
  • VolumeAttachment
  • Overview
  • Namespace
  • Class
  • Tree
  • Download

Class VolumeAttachment

The VolumeAttachment class represents a volume that is attached to a server.

OpenCloud\Common\Base
Extended by OpenCloud\Common\PersistentObject
Extended by OpenCloud\Compute\VolumeAttachment
Namespace: OpenCloud\Compute
Located at OpenCloud/Compute/VolumeAttachment.php
Methods summary
public HttpResponse
# update( array $params = array() )

updates are not permitted

updates are not permitted

Parameters

$params
array
$params array of values to set when updating the object

Returns

HttpResponse

Throws

OpenCloud\UpdateError
always

Overrides

OpenCloud\Common\PersistentObject::update()
public string
# name( )

returns a readable name for the attachment

returns a readable name for the attachment

Since there is no 'name' attribute, we'll hardcode something

Returns

string

Throws

NameError
if attribute 'name' is not defined

Api

Overrides

OpenCloud\Common\PersistentObject::name()
protected stdClass
# createJson( )

returns the JSON object for Create()

returns the JSON object for Create()

Returns

stdClass

Throws

CreateError
if not overridden

Overrides

OpenCloud\Common\PersistentObject::createJson()
Methods inherited from OpenCloud\Common\PersistentObject
__construct(), __set(), action(), checkExtension(), create(), createUrl(), customAction(), delete(), findLink(), getParent(), getService(), id(), jsonCollectionElement(), jsonCollectionName(), jsonName(), noCreate(), noDelete(), noUpdate(), parent(), primaryKeyField(), refresh(), region(), resourceName(), service(), setParent(), setService(), status(), updateJson(), url(), waitFor()
Methods inherited from OpenCloud\Common\Base
checkJsonError(), getHttpRequestObject(), getLogger(), makeQueryString(), populate(), setLogger(), setProperty()
Properties summary
public mixed $id
#
public mixed $device
#
public mixed $serverId
#
public mixed $volumeId
#
public static string $json_name 'volumeAttachment'
#
public static string $url_resource 'os-volume_attachments'
#
PHP OpenCloud API API documentation generated by ApiGen 2.8.0