Overview
  • Namespace
  • Class

Namespaces

  • OpenCloud
    • Autoscale
      • 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
      • Exception
      • Resource
      • Upload
    • Orchestration
      • Resource
    • Queues
      • Collection
      • Exception
      • Resource
    • Volume
      • Resource

Classes

  • Service

Class Service

The Orchestration class represents the OpenStack Heat service.

Heat is a service to orchestrate multiple composite cloud applications using the AWS CloudFormation template format, through both an OpenStack-native ReST API and a CloudFormation-compatible Query API.

OpenCloud\Common\Base
Extended by OpenCloud\Common\Service\AbstractService implements OpenCloud\Common\Service\ServiceInterface
Extended by OpenCloud\Common\Service\CatalogService
Extended by OpenCloud\Orchestration\Service
Namespace: OpenCloud\Orchestration
Codecoverageignore
Located at OpenCloud/Orchestration/Service.php

Methods summary

public OpenCloud\Orchestration\Resource\Stack
# stack( string $name = null )

Returns a Stack object associated with this Orchestration service

Returns a Stack object associated with this Orchestration service

Parameters

$name
Name of stack to retrieve

Returns

OpenCloud\Orchestration\Resource\Stack
object
public OpenCloud\Orchestration\Resource\Stack
# previewStack( array $params = array() )

Previews a Stack from a template and returns it.

Previews a Stack from a template and returns it.

Parameters

$params
Stack preview parameters

Returns

OpenCloud\Orchestration\Resource\Stack
Object representing previewed stack
public OpenCloud\Orchestration\Resource\Stack
# createStack( array $params = array() )

Creates a new Stack and returns it.

Creates a new Stack and returns it.

Parameters

$params
Stack creation parameters

Returns

OpenCloud\Orchestration\Resource\Stack
Object representing created stack
public OpenCloud\Orchestration\Resource\Stack
# adoptStack( array $params = array() )

Adopts a Stack and returns it.

Adopts a Stack and returns it.

Parameters

$params
Stack adoption parameters

Returns

OpenCloud\Orchestration\Resource\Stack
Object representing adopted stack
public OpenCloud\Orchestration\Resource\Stack
# getStack( string $name )

Returns a Stack object associated with this Orchestration service

Returns a Stack object associated with this Orchestration service

Parameters

$name
Name of stack to retrieve

Returns

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

Returns a list of stacks you created

Returns a list of stacks you created

Parameters

$params

Returns

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

Returns a list of resource types available

Returns a list of resource types available

Parameters

$params

Returns

OpenCloud\Common\Collection\PaginatedIterator
public OpenCloud\Orchestration\Resource\ResourceType
# getResourceType( string $id )

Returns a ResourceType object associated with this Orchestration service

Returns a ResourceType object associated with this Orchestration service

Parameters

$id
  • the resource type with the ID is retrieved

Returns

OpenCloud\Orchestration\Resource\ResourceType
object
public BuildInfo
# getBuildInfo( )

Returns a BuildInfo object associated with this Orchestration service

Returns a BuildInfo object associated with this Orchestration service

Returns

BuildInfo
object
public
# validateTemplate( array $params = array() )

Validates the given template

Validates the given template

Throws

OpenCloud\Common\Exceptions\InvalidTemplateError
if template is invalid
public array
# namespaces( )

Return namespaces.

Return namespaces.

Returns

array

Methods inherited from OpenCloud\Common\Service\CatalogService

__construct(), getBaseUrl(), getExtensions(), getName(), getRegion(), getType(), getUrl(), getUrlType(), limits()

Methods inherited from OpenCloud\Common\Service\AbstractService

collection(), getClient(), getEndpoint(), getNamespaces(), getResources(), resource(), resourceList(), setClient(), setEndpoint()

Methods inherited from OpenCloud\Common\Base

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

Magic methods summary

Constants summary

string DEFAULT_TYPE
# 'orchestration'
string DEFAULT_NAME
# 'cloudOrchestration'

Constants inherited from OpenCloud\Common\Service\CatalogService

DEFAULT_URL_TYPE, SUPPORTED_VERSION

API documentation generated by ApiGen