Overview
  • Namespace
  • Class

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

Classes

  • BaseResource
  • NovaResource
  • PersistentResource
  • ReadOnlyResource

Class PersistentResource

The root class for all other objects used or defined by this SDK.

It contains common code for error handling as well as service functions that are useful. Because it is an abstract class, it cannot be called directly, and it has no publicly-visible properties.

OpenCloud\Common\Base
Extended by OpenCloud\Common\Resource\BaseResource
Extended by OpenCloud\Common\Resource\PersistentResource

Direct known subclasses

OpenCloud\CDN\Resource\Flavor, OpenCloud\CDN\Resource\Service, OpenCloud\Database\Resource\DatastoreVersion, OpenCloud\Database\Resource\User, OpenCloud\DNS\Resource\AbstractResource, OpenCloud\LoadBalancer\Resource\AbstractResource, OpenCloud\LoadBalancer\Resource\CertificateMapping, OpenCloud\LoadBalancer\Resource\LoadBalancer, OpenCloud\LoadBalancer\Resource\Node, OpenCloud\Networking\Resource\Network, OpenCloud\Networking\Resource\Port, OpenCloud\Networking\Resource\SecurityGroup, OpenCloud\Common\PersistentObject, OpenCloud\Networking\Resource\SecurityGroupRule, OpenCloud\Networking\Resource\Subnet, OpenCloud\Orchestration\Resource\Stack, OpenCloud\Queues\Resource\Queue, OpenCloud\Volume\Resource\Snapshot, OpenCloud\Volume\Resource\Volume, OpenCloud\Volume\Resource\VolumeType, OpenCloud\Common\Resource\NovaResource, OpenCloud\Common\Resource\ReadOnlyResource, OpenCloud\Compute\Resource\Network, OpenCloud\Database\Resource\Backup, OpenCloud\Database\Resource\Configuration, OpenCloud\Database\Resource\Database, OpenCloud\Database\Resource\Datastore

Indirect known subclasses

OpenCloud\Autoscale\Resource\AbstractResource, OpenCloud\Autoscale\Resource\Group, OpenCloud\CloudMonitoring\Resource\AgentHostInfo, OpenCloud\CloudMonitoring\Resource\AgentTarget, OpenCloud\CloudMonitoring\Resource\AgentToken, OpenCloud\CloudMonitoring\Resource\Alarm, OpenCloud\CloudMonitoring\Resource\Changelog, OpenCloud\CloudMonitoring\Resource\Check, OpenCloud\CloudMonitoring\Resource\CheckType, OpenCloud\CloudMonitoring\Resource\Entity, OpenCloud\CloudMonitoring\Resource\Metric, OpenCloud\CloudMonitoring\Resource\MetricDataPoint, OpenCloud\Autoscale\Resource\GroupConfiguration, OpenCloud\CloudMonitoring\Resource\Notification, OpenCloud\CloudMonitoring\Resource\NotificationHistory, OpenCloud\CloudMonitoring\Resource\NotificationPlan, OpenCloud\CloudMonitoring\Resource\NotificationType, OpenCloud\CloudMonitoring\Resource\ReadOnlyResource, OpenCloud\CloudMonitoring\Resource\View, OpenCloud\CloudMonitoring\Resource\Zone, OpenCloud\Compute\Resource\Flavor, OpenCloud\Compute\Resource\Image, OpenCloud\Compute\Resource\KeyPair, OpenCloud\Autoscale\Resource\LaunchConfiguration, OpenCloud\Compute\Resource\Server, OpenCloud\Compute\Resource\VolumeAttachment, OpenCloud\Database\Resource\Instance, OpenCloud\DNS\Resource\AsyncResponse, OpenCloud\DNS\Resource\Domain, OpenCloud\DNS\Resource\PtrRecord, OpenCloud\DNS\Resource\Record, OpenCloud\DNS\Resource\Subdomain, OpenCloud\Identity\Resource\Role, OpenCloud\Identity\Resource\Tenant, OpenCloud\Autoscale\Resource\ScalingPolicy, OpenCloud\Identity\Resource\Token, OpenCloud\Identity\Resource\User, OpenCloud\LoadBalancer\Resource\Access, OpenCloud\LoadBalancer\Resource\Algorithm, OpenCloud\LoadBalancer\Resource\AllowedDomain, OpenCloud\LoadBalancer\Resource\ConnectionLogging, OpenCloud\LoadBalancer\Resource\ConnectionThrottle, OpenCloud\LoadBalancer\Resource\ContentCaching, OpenCloud\LoadBalancer\Resource\ErrorPage, OpenCloud\LoadBalancer\Resource\HealthMonitor, OpenCloud\Autoscale\Resource\Webhook, OpenCloud\LoadBalancer\Resource\Metadata, OpenCloud\LoadBalancer\Resource\NodeEvent, OpenCloud\LoadBalancer\Resource\NonIdUriResource, OpenCloud\LoadBalancer\Resource\Protocol, OpenCloud\LoadBalancer\Resource\ReadOnlyResource, OpenCloud\LoadBalancer\Resource\SessionPersistence, OpenCloud\LoadBalancer\Resource\SSLTermination, OpenCloud\LoadBalancer\Resource\Stats, OpenCloud\LoadBalancer\Resource\UsageRecord, OpenCloud\LoadBalancer\Resource\VirtualIp, OpenCloud\CloudMonitoring\Resource\AbstractResource, OpenCloud\Orchestration\Resource\BuildInfo, OpenCloud\Orchestration\Resource\Event, OpenCloud\Orchestration\Resource\Resource, OpenCloud\Orchestration\Resource\ResourceType, OpenCloud\Queues\Resource\Claim, OpenCloud\Queues\Resource\Message, OpenCloud\CloudMonitoring\Resource\Agent, OpenCloud\CloudMonitoring\Resource\AgentConnection, OpenCloud\CloudMonitoring\Resource\AgentHost

Abstract
Namespace: OpenCloud\Common\Resource
Located at OpenCloud/Common/Resource/PersistentResource.php

Methods summary

public Guzzle\Http\Message\Response
# create( array $params = array() )

Create a new resource

Create a new resource

Parameters

$params

Returns

Guzzle\Http\Message\Response
public Guzzle\Http\Message\Response
# update( array $params = array() )

Update a resource

Update a resource

Parameters

$params

Returns

Guzzle\Http\Message\Response
public Guzzle\Http\Message\Response
# delete( )

Delete this resource

Delete this resource

Returns

Guzzle\Http\Message\Response
public Guzzle\Http\Message\Response
# refresh( null $id = null, null $url = null )

Refresh the state of a resource

Refresh the state of a resource

Parameters

$id
$url

Returns

Guzzle\Http\Message\Response

Throws

OpenCloud\Common\Exceptions\IdRequiredError
public
# refreshFromLocationUrl( $url )

Given a location URL, refresh this resource

Given a location URL, refresh this resource

Parameters

$url
public
# waitFor( null $state = null, null $timeout = null, null $callback = null, null $interval = null )

A method to repeatedly poll the API resource, waiting for an eventual state change

A method to repeatedly poll the API resource, waiting for an eventual state change

Parameters

$state
The expected state of the resource
$timeout
The maximum timeout to wait
$callback
The callback to use to check the state
$interval
How long between each refresh request
public boolean
# checkExtension( mixed $alias )

Check whether an extension is valid

Check whether an extension is valid

Parameters

$alias
The extension name

Returns

boolean

Throws

OpenCloud\Common\Exceptions\UnsupportedExtensionError
public string
# name( )

Deprecated

Returns

string

Throws

OpenCloud\Common\Exceptions\NameError
public mixed
# id( )

Deprecated

Returns

mixed
public string
# status( )

Deprecated

Returns

string
public mixed
# region( )

Deprecated

Returns

mixed
public Guzzle\Http\Url
# createUrl( )

Deprecated

Returns

Guzzle\Http\Url

Methods inherited from OpenCloud\Common\Resource\BaseResource

__construct(), findLink(), getClient(), getMetadata(), getParent(), getService(), getUrl(), jsonCollectionElement(), jsonCollectionName(), jsonName(), parseResponse(), resourceName(), setMetadata(), setParent(), setService(), url()

Methods inherited from OpenCloud\Common\Base

__call(), checkJsonError(), generateUuid(), getInstance(), getLogger(), hasLogger(), makeResourceIteratorOptions(), populate(), setLogger(), stripNamespace(), toCamel(), toUnderscores()

Constants summary

Constants inherited from OpenCloud\Common\Base

PATCH_CONTENT_TYPE

API documentation generated by ApiGen