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

  • AbstractService
  • Catalog
  • CatalogItem
  • CatalogService
  • Endpoint
  • NovaService
  • ServiceBuilder

Interfaces

  • ServiceInterface
  • Overview
  • Namespace
  • Class
  • Tree

Class CatalogService

This class defines a cloud service; a relationship between a specific OpenStack and a provided service, represented by a URL in the service catalog.

Because Service is an abstract class, it cannot be called directly. Provider services such as Rackspace Cloud Servers or OpenStack Swift are each subclassed from Service.

OpenCloud\Common\Base
Extended by OpenCloud\Common\Service\AbstractService implements OpenCloud\Common\Service\ServiceInterface
Extended by OpenCloud\Common\Service\CatalogService

Direct known subclasses

OpenCloud\Autoscale\Service, OpenCloud\CDN\Service, OpenCloud\CloudMonitoring\Service, OpenCloud\Common\Service\NovaService, OpenCloud\DNS\Service, OpenCloud\Image\Service, OpenCloud\Networking\Service, OpenCloud\ObjectStore\AbstractService, OpenCloud\Orchestration\Service, OpenCloud\Queues\Service

Indirect known subclasses

OpenCloud\Compute\Service, OpenCloud\Database\Service, OpenCloud\LoadBalancer\Service, OpenCloud\ObjectStore\CDNService, OpenCloud\ObjectStore\Service, OpenCloud\Volume\Service
Abstract
Namespace: OpenCloud\Common\Service
Located at OpenCloud/Common/Service/CatalogService.php
Methods summary
public
# __construct( Guzzle\Http\ClientInterface $client, string $type = null, string $name = null, string $region = null, string $urlType = null )

Creates a service object, based off the specified client.

Creates a service object, based off the specified client.

The service's URL is defined in the client's serviceCatalog; it uses the $type, $name, $region, and $urlType to find the proper endpoint and set it. If it cannot find a URL in the service catalog that matches the criteria, then an exception is thrown.

Parameters

$client
Client object
$type
Service type (e.g. 'compute')
$name
Service name (e.g. 'cloudServersOpenStack')
$region
Service region (e.g. 'DFW', 'ORD', 'IAD', 'LON', 'SYD' or 'HKG')
$urlType
Either 'publicURL' or 'internalURL'
public string
# getType( )

Returns

string
string
public string
# getRegion( )

Returns

string
string
public string
# getName( )

Returns

string
string
public string
# getUrlType( )

Returns

string
string
public Guzzle\Http\Url
# getUrl( string $path = null, array $query = array() )

Returns the URL for the Service

Returns the URL for the Service

Parameters

$path
URL path segment
$query
Array of query pairs

Returns

Guzzle\Http\Url
Guzzle\Http\Url
public array
# getExtensions( )

Returns the /extensions for the service

Returns the /extensions for the service

Returns

array
of objects

Api

public array
# limits( )

Returns the limits for the service

Returns the limits for the service

Returns

array
of limits
public Guzzle\Http\Url
# getBaseUrl( )

Get the base URL for this service, based on the set URL type.

Get the base URL for this service, based on the set URL type.

Returns

Guzzle\Http\Url
\Guzzle\Http\Url

Throws

OpenCloud\Common\Exceptions\ServiceException
\OpenCloud\Common\Exceptions\ServiceException
Methods inherited from OpenCloud\Common\Service\AbstractService
collection(), getClient(), getCurrentNamespace(), getEndpoint(), getNamespaces(), getResources(), resolveResourceClass(), resource(), resourceList(), setClient(), setEndpoint()
Methods inherited from OpenCloud\Common\Base
__call(), checkJsonError(), generateUuid(), getInstance(), getJsonHeader(), getLogger(), getPatchHeaders(), getProperty(), hasLogger(), makeResourceIteratorOptions(), populate(), propertyExists(), setLogger(), setProperty(), stripNamespace(), toCamel(), toUnderscores()
Constants summary
string DEFAULT_URL_TYPE
#'publicURL'
mixed SUPPORTED_VERSION
#null
Constants inherited from OpenCloud\Common\Base
PATCH_CONTENT_TYPE
Properties summary
protected boolean $regionless

Indicates whether a service is "regionless" or not. Defaults to FALSE because nearly all services
are region-specific.

Indicates whether a service is "regionless" or not. Defaults to FALSE because nearly all services are region-specific.

#false
Properties inherited from OpenCloud\Common\Service\AbstractService
$client, $endpoint, $namespaces, $resources
Properties inherited from OpenCloud\Common\Base
$aliases
API documentation generated by ApiGen 2.8.0