Documentation

Service extends NovaService
in package

OpenCloud

LoadBalancer

Class that encapsulates the Rackspace Cloud Load Balancers service

DEFAULT_NAME = 'cloudLoadBalancers'
DEFAULT_TYPE = 'rax:load-balancer'
DEFAULT_URL_TYPE = 'publicURL'
PATCH_CONTENT_TYPE = OpenCloudCommonConstantsMime::JSON_PATCH
SUPPORTED_VERSION = null
$aliases : array<string|int, mixed>: The aliases configure for the properties of the instance.
$client : Client
$endpoint : Endpoint
$namespaces : array<string|int, mixed>
$regionless : bool
$resources : array<string|int, mixed>
$logger : LoggerInterface: The logger instance
$name : string
$properties : array<string|int, mixed>: Holds all the properties added by overloading.
$region : string
$type : string
$urlType : string
__call() : mixed: Intercept non-existent method calls for dynamic getter/setter functionality.
__construct() : mixed: Creates a service object, based off the specified client.
algorithm() : Algorithm: single algorithm (should never be called directly)
algorithmList() : PaginatedIterator: Return a list of Algorithm objects
allowedDomain() : AllowedDomain: Returns an allowed domain
allowedDomainList() : PaginatedIterator: Returns Collection of AllowedDomain object
billableLoadBalancer() : mixed
billableLoadBalancerList() : PaginatedIterator: Returns a paginated collection of load balancers that have been billed between a certain period.
checkJsonError() : mixed: Checks the most recent JSON operation for errors.
collection() : mixed
flavor() : Flavor: Returns a flavor from the service
flavorList() : Collection: Returns a list of Flavor objects
generateUuid() : mixed
getBaseUrl() : Url: Get the base URL for this service, based on the set URL type.
getClient() : Client
getEndpoint() : Endpoint
getExtensions() : array<string|int, mixed>: Returns the /extensions for the service
getInstance() : static
getLogger() : LoggerInterface: Returns the Logger object.
getName() : string
getNamespaces() : array<string|int, mixed>: Returns a list of supported namespaces
getRegion() : string
getResources() : array<string|int, mixed>: Get all associated resources for this service.
getType() : string
getUrl() : Url: Returns the URL for the Service
getUrlType() : string
hasLogger() : bool
limits() : array<string|int, mixed>: Returns the limits for the service
loadBalancer() : LoadBalancer: Return a Load Balancer
loadBalancerList() : PaginatedIterator: Return a paginated collection of load balancers
makeResourceIteratorOptions() : mixed
name() : mixed
namespaces() : mixed
populate() : mixed: Populates the current object based on an unknown data type.
protocol() : Protocol: single protocol (should never be called directly)
protocolList() : PaginatedIterator: Returns a list of Protocol objects
region() : mixed
resource() : object: Factory method for instantiating resource objects.
resourceList() : PaginatedIterator: Factory method for instantiating a resource collection.
setClient() : mixed
setEndpoint() : mixed
setLogger() : $this: Sets the logger.
stripNamespace() : mixed
toCamel() : mixed: Convert a string to camelCase format.
toUnderscores() : mixed: Convert string to underscore format.
url() : mixed
getCurrentNamespace() : type: Internal method for accessing child namespace from parent scope.
getJsonHeader() : mixed
getPatchHeaders() : mixed
getProperty() : mixed: Grab value out of the data array.
loadNamespaces() : mixed: Loads the available namespaces from the /extensions resource
propertyExists() : bool: Basic check to see whether property exists.
resolveResourceClass() : string: Resolves FQCN for local resource.
setProperty() : mixed: We can set a property under three conditions:
checkAttributePrefix() : bool: Checks the attribute $property and only permits it if the prefix is in the specified $prefixes array
findEndpoint() : Endpoint: Extracts the appropriate endpoint from the service catalog based on the name and type of a service, and sets for further use.
getMetaUrl() : stdClass: Constructs a specified URL from the subresource
isAccessible() : bool: Does the property exist in the object variable list (i.e. does it have public or protected visibility?)

DEFAULT_NAME


    public
    mixed
    DEFAULT_NAME
    = 'cloudLoadBalancers'

DEFAULT_TYPE


    public
    mixed
    DEFAULT_TYPE
    = 'rax:load-balancer'

DEFAULT_URL_TYPE


    public
    mixed
    DEFAULT_URL_TYPE
    = 'publicURL'

PATCH_CONTENT_TYPE


    public
    mixed
    PATCH_CONTENT_TYPE
    = OpenCloudCommonConstantsMime::JSON_PATCH

SUPPORTED_VERSION


    public
    mixed
    SUPPORTED_VERSION
    = null

$aliases

The aliases configure for the properties of the instance.


    protected
        array<string|int, mixed>
    $aliases
     = array()

$client


    protected
        Client
    $client

The client which interacts with the API.

$endpoint


    protected
        Endpoint
    $endpoint

The endpoint for this service.

$namespaces


    protected
        array<string|int, mixed>
    $namespaces
     = array()

Namespaces for this service.

$regionless


    protected
        bool
    $regionless
     = false

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

$resources


    protected
        array<string|int, mixed>
    $resources
     = array()

A collection of resource models that this service has control over.

$logger

The logger instance


    private
        LoggerInterface
    $logger

$name


    private
        string
    $name

The name of this service, as set in Catalog.

$properties

Holds all the properties added by overloading.


    private
        array<string|int, mixed>
    $properties
     = array()

$region


    private
        string
    $region

The chosen region(s) for this service.

$type


    private
        string
    $type

The type of this service, as set in Catalog.

$urlType


    private
        string
    $urlType

Either 'publicURL' or 'internalURL'.

__call()

Intercept non-existent method calls for dynamic getter/setter functionality.


    public
                __call( $method,  $args) : mixed

Parameters

$method :
$args :

Return values

mixed —

__construct()

Creates a service object, based off the specified client.


    public
                __construct(Client $client[, string $type = null ][, string $name = null ][, string $region = null ][, string $urlType = null ]) : mixed

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: Client object
$type : string = null: Service type (e.g. 'compute')
$name : string = null: Service name (e.g. 'cloudServersOpenStack')
$region : string = null: Service region (e.g. 'DFW', 'ORD', 'IAD', 'LON', 'SYD' or 'HKG')
$urlType : string = null: Either 'publicURL' or 'internalURL'

Return values

mixed —

algorithm()

single algorithm (should never be called directly)


    public
                algorithm([mixed $data = null ]) : Algorithm

convenience method used by the Collection factory

Parameters

$data : mixed = null

Return values

Algorithm —

algorithmList()

Return a list of Algorithm objects


    public
                algorithmList() : PaginatedIterator

Return values

PaginatedIterator —

allowedDomain()

Returns an allowed domain


    public
                allowedDomain([mixed $data = null ]) : AllowedDomain

Parameters

$data : mixed = null: either an array of values or null

Return values

AllowedDomain —

allowedDomainList()

Returns Collection of AllowedDomain object


    public
                allowedDomainList() : PaginatedIterator

Return values

PaginatedIterator —

billableLoadBalancer()


    public
                billableLoadBalancer([mixed $id = null ]) : mixed

Parameters

$id : mixed = null

Return values

mixed —

billableLoadBalancerList()

Returns a paginated collection of load balancers that have been billed between a certain period.


    public
                billableLoadBalancerList([array<string|int, mixed> $filter = array() ]) : PaginatedIterator

Parameters

$filter : array<string|int, mixed> = array()

Return values

PaginatedIterator —

checkJsonError()

Checks the most recent JSON operation for errors.


    public
            static    checkJsonError() : mixed

Return values

mixed —

collection()


    public
                collection(mixed $class[, mixed $url = null ][, mixed $parent = null ][, mixed $data = null ]) : mixed

Parameters

$class : mixed
$url : mixed = null
$parent : mixed = null
$data : mixed = null

Return values

mixed —

flavor()

Returns a flavor from the service


    public
                flavor([string|null $id = null ]) : Flavor

Parameters

$id : string|null = null

Return values

Flavor —

flavorList()

Returns a list of Flavor objects


    public
                flavorList([bool $details = true ][, array<string|int, mixed> $filter = array() ]) : Collection

Parameters

$details : bool = true: Returns full details or not.
$filter : array<string|int, mixed> = array(): Array for creating queries

Return values

Collection —

generateUuid()


    public
            static    generateUuid() : mixed

Return values

mixed —

getBaseUrl()

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


    public
                getBaseUrl() : Url

Return values

Url —

getClient()


    public
                getClient() : Client

Return values

Client —

getEndpoint()


    public
                getEndpoint() : Endpoint

Return values

Endpoint —

getExtensions()

Returns the /extensions for the service


    public
                getExtensions() : array<string|int, mixed>

Return values

array<string|int, mixed> —

of objects

getInstance()


    public
            static    getInstance() : static

Return values

static —

getLogger()

Returns the Logger object.


    public
                getLogger() : LoggerInterface

Return values

LoggerInterface —

getName()


    public
                getName() : string

Return values

string —

getNamespaces()

Returns a list of supported namespaces


    public
                getNamespaces() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getRegion()


    public
                getRegion() : string

Return values

string —

getResources()

Get all associated resources for this service.


    public
                getResources() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getType()


    public
                getType() : string

Return values

string —

getUrl()

Returns the URL for the Service


    public
                getUrl([string $path = null ][, array<string|int, mixed> $query = array() ]) : Url

Parameters

$path : string = null: URL path segment
$query : array<string|int, mixed> = array(): Array of query pairs

Return values

Url —

getUrlType()


    public
                getUrlType() : string

Return values

string —

hasLogger()


    public
                hasLogger() : bool

Return values

bool —

limits()

Returns the limits for the service


    public
                limits() : array<string|int, mixed>

Return values

array<string|int, mixed> —

of limits

loadBalancer()

Return a Load Balancer


    public
                loadBalancer([string $id = null ]) : LoadBalancer

Parameters

$id : string = null

Return values

LoadBalancer —

loadBalancerList()

Return a paginated collection of load balancers


    public
                loadBalancerList([bool $detail = true ][, array<string|int, mixed> $filter = array() ]) : PaginatedIterator

Parameters

$detail : bool = true: If TRUE, all details are returned; otherwise, a minimal set (ID, name) is retrieved [DEPRECATED]
$filter : array<string|int, mixed> = array(): Optional query params used for search

Return values

PaginatedIterator —

makeResourceIteratorOptions()


    public
                makeResourceIteratorOptions(mixed $resource) : mixed

Parameters

$resource : mixed

Return values

mixed —

name()


    public
                name() : mixed

Return values

mixed —

namespaces()


    public
                namespaces() : mixed

Return values

mixed —

populate()

Populates the current object based on an unknown data type.


    public
                populate(mixed $info[, mixed $setObjects = true ]) : mixed

Parameters

$info : mixed
$setObjects : mixed = true

Return values

mixed —

protocol()

single protocol (should never be called directly)


    public
                protocol([mixed $data = null ]) : Protocol

Convenience method to be used by the ProtocolList Collection.

Parameters

$data : mixed = null

Return values

Protocol —

protocolList()

Returns a list of Protocol objects


    public
                protocolList() : PaginatedIterator

Return values

PaginatedIterator —

region()


    public
                region() : mixed

Return values

mixed —

resource()

Factory method for instantiating resource objects.


    public
                resource(string $resourceName[, mixed $info = null ][, mixed $parent = null ]) : object

Parameters

$resourceName : string
$info : mixed = null: (default: null)
$parent : mixed = null: The parent object

Return values

object —

resourceList()

Factory method for instantiating a resource collection.


    public
                resourceList(string $resourceName[, string|null $url = null ][, string|null $parent = null ]) : PaginatedIterator

Parameters

$resourceName : string
$url : string|null = null
$parent : string|null = null

Return values

PaginatedIterator —

setClient()


    public
                setClient(ClientInterface $client) : mixed

Parameters

$client : ClientInterface

Return values

mixed —

setEndpoint()


    public
                setEndpoint(Endpoint $endpoint) : mixed

Parameters

$endpoint : Endpoint

Return values

mixed —

setLogger()

Sets the logger.


    public
                setLogger([LoggerInterface $logger = null ]) : $this

Parameters

$logger : LoggerInterface = null

Return values

$this —

stripNamespace()


    public
                stripNamespace(mixed $namespace) : mixed

Parameters

$namespace : mixed

Return values

mixed —

toCamel()

Convert a string to camelCase format.


    public
                toCamel( $string[, bool $capitalise = true ]) : mixed

Parameters

$string :
$capitalise : bool = true: Optional flag which allows for word capitalization.

Return values

mixed —

toUnderscores()

Convert string to underscore format.


    public
                toUnderscores( $string) : mixed

Parameters

$string :

Return values

mixed —

url()


    public
                url([mixed $path = null ][, array<string|int, mixed> $query = array() ]) : mixed

Parameters

$path : mixed = null
$query : array<string|int, mixed> = array()

Return values

mixed —

getCurrentNamespace()

Internal method for accessing child namespace from parent scope.


    protected
                getCurrentNamespace() : type

Return values

type —

getJsonHeader()


    protected
            static    getJsonHeader() : mixed

Return values

mixed —

getPatchHeaders()


    protected
            static    getPatchHeaders() : mixed

Return values

mixed —

getProperty()

Grab value out of the data array.


    protected
                getProperty(string $property) : mixed

Parameters

$property : string

Return values

mixed —

loadNamespaces()

Loads the available namespaces from the /extensions resource


    protected
                loadNamespaces() : mixed

Return values

mixed —

propertyExists()

Basic check to see whether property exists.


    protected
                propertyExists(string $property[, bool $allowRetry = true ]) : bool

Parameters

$property : string: The property name being investigated.
$allowRetry : bool = true: If set to TRUE, the check will try to format the name in underscores because there are sometimes discrepancies between camelCaseNames and underscore_names.

Return values

bool —

resolveResourceClass()

Resolves FQCN for local resource.


    protected
                resolveResourceClass( $resourceName) : string

Parameters

$resourceName :

Return values

string —

setProperty()

We can set a property under three conditions:


    protected
                setProperty(mixed $property, mixed $value) : mixed

If it has a concrete setter: setProperty()
If the property exists
If the property name's prefix is in an approved list

Parameters

$property : mixed
$value : mixed

Return values

mixed —

checkAttributePrefix()

Checks the attribute $property and only permits it if the prefix is in the specified $prefixes array


    private
                checkAttributePrefix(string $property) : bool

This is to support extension namespaces in some services.

Parameters

$property : string: the name of the attribute

Return values

bool —

findEndpoint()

Extracts the appropriate endpoint from the service catalog based on the name and type of a service, and sets for further use.


    private
                findEndpoint() : Endpoint

Return values

Endpoint —

getMetaUrl()

Constructs a specified URL from the subresource


    private
                getMetaUrl(string $resource) : stdClass

Given a subresource (e.g., "extensions"), this constructs the proper URL and retrieves the resource.

Parameters

$resource : string: The resource requested; should NOT have slashes at the beginning or end

Return values

stdClass —

object

isAccessible()

Does the property exist in the object variable list (i.e. does it have public or protected visibility?)


    private
                isAccessible( $property) : bool

Parameters

$property :

Return values

bool —