OpenCloud/LoadBalancer/Service.php

Properties

Description

Rackspace's Cloud Load Balancers

Classes

Service

Properties

 
 
No 
No 

Description

The Rackspace Cloud Load Balancers
Nova is used as a basis for several products, including Compute services as well as Rackspace's Cloud Databases. This class is, in essence, a vehicle for sharing common code between those other classes.

Methods

Algorithm, AlgorithmList, AllowedDomain, AllowedDomainList, BillableLoadBalancer, BillableLoadBalancerList, LoadBalancer, LoadBalancerList, Protocol, ProtocolList, Url, __construct,

Algorithm(   $data = null, ) : \OpenCloud\LoadBalancer\LoadBalancerService\Algorithm

Description

single algorithm (should never be called directly)
convenience method used by the Collection factory

Arguments

Name Type Description Default
$data n/a null

Return value

Type Description
\OpenCloud\LoadBalancer\LoadBalancerService\Algorithm

AlgorithmList( ) : \OpenCloud\LoadBalancer\Collection

Description

a list of Algorithm objects

Return value

Type Description
\OpenCloud\LoadBalancer\Collection

Tags

Name Description
api

AllowedDomain( mixed   $data = null, ) : \OpenCloud\LoadBalancer\LoadBalancerService\AllowedDomain

Description

returns allowed domain

Arguments

Name Type Description Default
$data mixed

either an array of values or null

null

Return value

Type Description
\OpenCloud\LoadBalancer\LoadBalancerService\AllowedDomain

Tags

Name Description
api

AllowedDomainList( ) : \OpenCloud\LoadBalancer\Collection

Description

returns Collection of AllowedDomain object

Return value

Type Description
\OpenCloud\LoadBalancer\Collection

Tags

Name Description
api

BillableLoadBalancer( string   $id = null, ) : \OpenCloud\LoadBalancer\LoadBalancerService\LoadBalancer

Description

creates a new BillableLoadBalancer object (read-only)

Arguments

Name Type Description Default
$id string

the identifier of the load balancer

null

Return value

Type Description
\OpenCloud\LoadBalancer\LoadBalancerService\LoadBalancer

Tags

Name Description
api

BillableLoadBalancerList( boolean   $detail = true, array   $filter = array(), ) : \OpenCloud\Collection

Description

returns a Collection of BillableLoadBalancer objects

Arguments

Name Type Description Default
$detail boolean

if TRUE (the default), then all details are returned; otherwise, the minimal set (ID, name) are retrieved

true
$filter array

if provided, a set of key/value pairs that are set as query string parameters to the query

array()

Return value

Type Description
\OpenCloud\Collection

Tags

Name Description
api

LoadBalancer( string   $id = NULL, ) : \OpenCloud\LoadBalancer\LoadBalancerService\LoadBalancer

Description

creates a new LoadBalancer object

Arguments

Name Type Description Default
$id string

the identifier of the load balancer

NULL

Return value

Type Description
\OpenCloud\LoadBalancer\LoadBalancerService\LoadBalancer

Tags

Name Description
api

LoadBalancerList( boolean   $detail = true, array   $filter = array(), ) : \OpenCloud\Collection

Description

returns a Collection of LoadBalancer objects

Arguments

Name Type Description Default
$detail boolean

if TRUE (the default), then all details are returned; otherwise, the minimal set (ID, name) are retrieved

true
$filter array

if provided, a set of key/value pairs that are set as query string parameters to the query

array()

Return value

Type Description
\OpenCloud\Collection

Tags

Name Description
api

Protocol(   $data = null, ) : \OpenCloud\LoadBalancer\LoadBalancerService\Protocol

Description

single protocol (should never be called directly)
Convenience method to be used by the ProtocolList Collection.

Arguments

Name Type Description Default
$data n/a null

Return value

Type Description
\OpenCloud\LoadBalancer\LoadBalancerService\Protocol

ProtocolList( ) : \OpenCloud\LoadBalancer\Collection

Description

a list of Protocol objects

Return value

Type Description
\OpenCloud\LoadBalancer\Collection

Tags

Name Description
api

Url( string   $resource = self::URL_RESOURCE, array   $args = array(), ) : n/a

Description

Returns the URL of this service, or optionally that of an instance

Arguments

Name Type Description Default
$resource string

the resource required

self::URL_RESOURCE
$args array

extra arguments to pass to the URL as query strings

array()

Return value

Type Description
n/a n/a

__construct( \OpenCloud\OpenStack   $conn, string   $name, string   $region, string   $urltype, ) : n/a

Description

Creates a new LoadBalancerService connection
This is not normally called directly, but via the factory method on the OpenStack or Rackspace connection object.

Arguments

Name Type Description Default
$conn \OpenCloud\OpenStack

the connection on which to create the service

$name string

the name of the service (e.g., "cloudDatabases")

$region string

the region of the service (e.g., "DFW" or "LON")

$urltype string

the type of URL (normally "publicURL")

Return value

Type Description
n/a n/a

Constants

  JSON_ELEMENT = 'loadBalancers'




  SERVICE_OBJECT_CLASS = 'LoadBalancer'




  SERVICE_TYPE = 'rax:load-balancer'




  URL_RESOURCE = 'loadbalancers'




Documentation was generated by phpDocumentor 2.0.0b6 .

Namespaces

Packages