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

  • AbstractResource
  • Group
  • GroupConfiguration
  • LaunchConfiguration
  • ScalingPolicy
  • Webhook
  • Overview
  • Namespace
  • Class
  • Tree
  • Download

Class AbstractResource

Contains generic, abstracted functionality for Autoscale resources.

OpenCloud\Common\Base
Extended by OpenCloud\Common\PersistentObject
Extended by OpenCloud\Autoscale\Resource\AbstractResource

Direct known subclasses

OpenCloud\Autoscale\Resource\Group, OpenCloud\Autoscale\Resource\GroupConfiguration, OpenCloud\Autoscale\Resource\LaunchConfiguration, OpenCloud\Autoscale\Resource\ScalingPolicy, OpenCloud\Autoscale\Resource\Webhook
Abstract
Namespace: OpenCloud\Autoscale\Resource
Located at OpenCloud/Autoscale/Resource/AbstractResource.php
Methods summary
public string
# url( string|null $subResource = null, boolean $includeId = true )

Returns the URL for this resource.

Returns the URL for this resource.

Parameters

$subResource
string|null
$subResource
$includeId
boolean
$includeId

Returns

string

Throws

UrlError
if URL is not defined

Overrides

OpenCloud\Common\PersistentObject::url()
public stdClass
# createJson( )

Creates the object which will be JSON encoded for request.

Creates the object which will be JSON encoded for request.

Returns

stdClass

Throws

CreateError
if not overridden

Overrides

OpenCloud\Common\PersistentObject::createJson()
protected array
# updateJson( mixed $params = array() )

Creates the object which will be JSON encoded for request.

Creates the object which will be JSON encoded for request.

Returns

array

Throws

UpdateError
if not overridden

Overrides

OpenCloud\Common\PersistentObject::updateJson()
public OpenCloud\Autoscale\Resource\AbstractResource
# resource( string $name, string $info )

Factory method for returning a resource. This is mostly used when a Collection instantiates an individual resource (i.e. in next() calls).

Factory method for returning a resource. This is mostly used when a Collection instantiates an individual resource (i.e. in next() calls).

Parameters

$name
string
$name
$info
string
$info

Returns

OpenCloud\Autoscale\Resource\AbstractResource
Methods inherited from OpenCloud\Common\PersistentObject
__construct(), __set(), action(), checkExtension(), create(), createUrl(), customAction(), delete(), findLink(), getParent(), getService(), id(), jsonCollectionElement(), jsonCollectionName(), jsonName(), name(), noCreate(), noDelete(), noUpdate(), parent(), primaryKeyField(), refresh(), region(), resourceName(), service(), setParent(), setService(), status(), update(), waitFor()
Methods inherited from OpenCloud\Common\Base
checkJsonError(), getHttpRequestObject(), getLogger(), makeQueryString(), populate(), setLogger(), setProperty()
Properties summary
public array $createKeys array()
#

These are used to set the object used for JSON encode.

These are used to set the object used for JSON encode.

public array $associatedResources array()
#

These resources are associated with this one. When this resource object is populated, if a key is found matching one of these array keys, it is set as an instantiated resource object (rather than an arbitrary string or stdClass object).

These resources are associated with this one. When this resource object is populated, if a key is found matching one of these array keys, it is set as an instantiated resource object (rather than an arbitrary string or stdClass object).

public array $associatedCollections array()
#

Same as an associated resource, but it's instantiated as a Collection.

Same as an associated resource, but it's instantiated as a Collection.

Properties inherited from OpenCloud\Common\PersistentObject
$id
PHP OpenCloud API API documentation generated by ApiGen 2.8.0