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

  • BuildInfo
  • Event
  • Resource
  • ResourceType
  • Stack
  • Overview
  • Namespace
  • Class
  • Tree

Class Stack

Class that represents a stack.

OpenCloud\Common\Base
Extended by OpenCloud\Common\Resource\BaseResource
Extended by OpenCloud\Common\Resource\PersistentResource
Extended by OpenCloud\Orchestration\Resource\Stack
Namespace: OpenCloud\Orchestration\Resource
Package: OpenCloud\Orchestration\Resource
See: http://developer.openstack.org/api-ref-orchestration-v1.html#stacks
Located at OpenCloud/Orchestration/Resource/Stack.php
Methods summary
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()
protected
# updateJson( mixed $params = array() )

Provides JSON for update request body

Provides JSON for update request body

Overrides

OpenCloud\Common\Resource\PersistentResource::updateJson()
public Guzzle\Http\Message\Response
# adopt( array $params )

Creates a new stack by adopting resources from an abandoned stack

Creates a new stack by adopting resources from an abandoned stack

Parameters

$params
Adopt stack parameters

Returns

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

Previews the stack without actually creating it

Previews the stack without actually creating it

Parameters

$params
Preview stack parameters

Returns

Guzzle\Http\Message\Response
Guzzle\Http\Message\Response
public string
# abandon( )

Abandons the stack and returns abandoned stack data.

Abandons the stack and returns abandoned stack data.

Returns

string
Abandoned stack data (which could be passed to the adopt stack operation as adoptStackData).
public OpenCloud\Orchestration\Resource\Resource
# getResource( string $name )

Returns a Resource object associated with this Stack

Returns a Resource object associated with this Stack

Parameters

$name
Stack resource name

Returns

OpenCloud\Orchestration\Resource\Resource
object
public OpenCloud\Common\Collection\PaginatedIterator
# listResources( array $params = array() )

Returns a list of Resources associated with this Stack

Returns a list of Resources associated with this Stack

Parameters

$params

Returns

OpenCloud\Common\Collection\PaginatedIterator
\OpenCloud\Common\Collection\PaginatedIterator
public OpenCloud\Common\Collection\PaginatedIterator
# listEvents( array $params = array() )

Returns a list of Events associated with this Stack

Returns a list of Events associated with this Stack

Parameters

$params

Returns

OpenCloud\Common\Collection\PaginatedIterator
\OpenCloud\Common\Collection\PaginatedIterator
public
# event( mixed $id )

Iterator use only

Iterator use only

public String
# getStackTemplate( )

Returns the template for this stack.

Returns the template for this stack.

Returns

String
template
protected
# previewUrl( )
protected
# abandonUrl( )
protected string
# primaryKeyField( )

Returns the primary key field for the object

Returns the primary key field for the object

Returns

string
string

Overrides

OpenCloud\Common\Resource\BaseResource::primaryKeyField()
Methods inherited from OpenCloud\Common\Resource\PersistentResource
checkExtension(), create(), delete(), generateJsonPatch(), getAlias(), getUpdateablePropertiesAsArray(), noCreate(), noDelete(), noUpdate(), recursivelyAliasPropertyValue(), refresh(), refreshFromLocationUrl(), refreshFromParent(), update(), waitFor()
Methods inherited from OpenCloud\Common\Resource\BaseResource
__construct(), findLink(), getClient(), getMetadata(), getParent(), getService(), getUrl(), jsonCollectionElement(), jsonCollectionName(), jsonName(), parseResponse(), 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
protected static string $url_resource
#'stacks'
protected static string $json_name
#'stack'
protected mixed $id
#
protected mixed $parentStack
#
protected mixed $disableRollback
#
protected mixed $description
#
protected mixed $parameters
#
protected mixed $environment
#
protected mixed $files
#
protected mixed $name
#
protected mixed $status
#
protected mixed $statusReason
#
protected mixed $outputs
#
protected mixed $creationTime
#
protected mixed $updatedTime
#
protected mixed $timeoutMins
#
protected mixed $templateUrl
#
protected mixed $template
#
protected mixed $adoptStackData
#
protected mixed $links
#
protected array $aliases

The aliases configure for the properties of the instance.

The aliases configure for the properties of the instance.

#array( 'parent' => 'parentStack', 'disable_rollback' => 'disableRollback', 'stack_name' => 'name', 'stack_status' => 'status', 'stack_status_reason' => 'statusReason', 'creation_time' => 'creationTime', 'updated_time' => 'updatedTime', 'timeout_mins' => 'timeoutMins', 'template_url' => 'templateUrl', 'adopt_stack_data' => 'adoptStackData' )
protected array $createKeys
#array( 'name', 'templateUrl', 'template', 'environment', 'files', 'parameters', 'timeoutMins', 'adoptStackData' )
protected array $updateKeys
#array( 'templateUrl', 'template', 'environment', 'files', 'parameters', 'timeoutMins' )
Properties inherited from OpenCloud\Common\Resource\BaseResource
$metadata, $parent, $service
API documentation generated by ApiGen 2.8.0