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

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

Class Snapshot

The Snapshot class represents a single block storage snapshot

OpenCloud\Common\Base
Extended by OpenCloud\Common\PersistentObject
Extended by OpenCloud\Volume\Snapshot
Namespace: OpenCloud\Volume
Author: Glen Campbell <glen.campbell@rackspace.com>
Api
Located at OpenCloud/Volume/Snapshot.php
Methods summary
public
# Update( mixed $params = array() )

updates are not permitted

updates are not permitted

Throws

OpenCloud\UpdateError
always
public string
# Name( )

returns the display_name attribute

returns the display_name attribute

Returns

string

Api

protected stdClass
# CreateJson( )

returns the object for the Create() method's JSON

returns the object for the Create() method's JSON

Returns

stdClass
Methods inherited from OpenCloud\Common\PersistentObject
__construct(), __set(), action(), checkExtension(), create(), createJson(), createUrl(), customAction(), delete(), findLink(), getParent(), getService(), id(), jsonCollectionElement(), jsonCollectionName(), jsonName(), name(), noCreate(), noDelete(), noUpdate(), parent(), primaryKeyField(), refresh(), region(), resourceName(), service(), setParent(), setService(), status(), update(), updateJson(), url(), waitFor()
Methods inherited from OpenCloud\Common\Base
checkJsonError(), getHttpRequestObject(), getLogger(), makeQueryString(), populate(), setLogger(), setProperty()
Properties summary
public mixed $id
#
public mixed $display_name
#
public mixed $display_description
#
public mixed $volume_id
#
public mixed $status
#
public mixed $size
#
public mixed $created_at
#
public mixed $metadata
#
protected boolean $force false
#
protected static string $json_name 'snapshot'
#
protected static string $url_resource 'snapshots'
#
Magic properties summary
public string $id
#

the identifier (usually a GUID)

the identifier (usually a GUID)

public string $display_name
#

the name of the snapshot

the name of the snapshot

public string $display_description
#

the description

the description

public string $volume_id
#

the ID of the associated volume (GUID)

the ID of the associated volume (GUID)

public string $status
#

a regular status value

a regular status value

public integer $size
#

the size of the snapshot

the size of the snapshot

public datetime $created_at
#

the date/time the snapshot was created

the date/time the snapshot was created

public object $metadata
#

metadata associated with the snapshot

metadata associated with the snapshot

PHP OpenCloud API API documentation generated by ApiGen 2.8.0