Overview

Namespaces

  • None
  • OpenCloud
    • Autoscale
      • Resource
    • CloudMonitoring
      • Exception
      • Resource
    • Common
      • Exceptions
      • Log
      • Request
        • Response
    • Compute
    • Database
    • DNS
    • LoadBalancer
      • Resources
    • ObjectStore
      • Resource
    • Orchestration
    • Volume
  • PHP

Classes

  • Service
  • Overview
  • Namespace
  • Class
  • Tree
  • Download

Class Service

The Rackspace Cloud Load Balancers

OpenCloud\Common\Base
Extended by OpenCloud\Common\Service
Extended by OpenCloud\Common\Nova
Extended by OpenCloud\LoadBalancer\Service
Namespace: OpenCloud\LoadBalancer
Located at OpenCloud/LoadBalancer/Service.php
Methods summary
public
# __construct( OpenCloud\OpenStack $conn, string $name, string $region, string $urltype )

Creates a new LoadBalancerService connection

Creates a new LoadBalancerService connection

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

Parameters

$conn
OpenCloud\OpenStack
$conn the connection on which to create the service
$name
string
$name the name of the service (e.g., "cloudDatabases")
$region
string
$region the region of the service (e.g., "DFW" or "LON")
$urltype
string
$urltype the type of URL (normally "publicURL")

Overrides

OpenCloud\Common\Nova::__construct()
public string
# url( string $resource = OpenCloud\LoadBalancer\Service::URL_RESOURCE, array $args = array() )

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

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

Parameters

$resource
string
$resource the resource required
$args
array
$args extra arguments to pass to the URL as query strings

Returns

string

Throws

UrlError

Overrides

OpenCloud\Common\Service::url()
public LoadBalancerService\LoadBalancer
# loadBalancer( string $id = null )

creates a new LoadBalancer object

creates a new LoadBalancer object

Parameters

$id
string
$id the identifier of the load balancer

Returns

LoadBalancerService\LoadBalancer

Api

public OpenCloud\Collection
# loadBalancerList( boolean $detail = true, array $filter = array() )

returns a Collection of LoadBalancer objects

returns a Collection of LoadBalancer objects

Parameters

$detail
boolean
$detail if TRUE (the default), then all details are returned; otherwise, the minimal set (ID, name) are retrieved
$filter
array
$filter if provided, a set of key/value pairs that are set as query string parameters to the query

Returns

OpenCloud\Collection

Api

public LoadBalancerService\LoadBalancer
# billableLoadBalancer( string $id = null )

creates a new BillableLoadBalancer object (read-only)

creates a new BillableLoadBalancer object (read-only)

Parameters

$id
string
$id the identifier of the load balancer

Returns

LoadBalancerService\LoadBalancer

Api

public OpenCloud\Collection
# billableLoadBalancerList( boolean $detail = true, array $filter = array() )

returns a Collection of BillableLoadBalancer objects

returns a Collection of BillableLoadBalancer objects

Parameters

$detail
boolean
$detail if TRUE (the default), then all details are returned; otherwise, the minimal set (ID, name) are retrieved
$filter
array
$filter if provided, a set of key/value pairs that are set as query string parameters to the query

Returns

OpenCloud\Collection

Api

public LoadBalancerService\AllowedDomain
# allowedDomain( mixed $data = null )

returns allowed domain

returns allowed domain

Parameters

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

Returns

LoadBalancerService\AllowedDomain

Api

public Collection
# allowedDomainList( )

returns Collection of AllowedDomain object

returns Collection of AllowedDomain object

Returns

Collection

Api

public LoadBalancerService\Protocol
# protocol( mixed $data = null )

single protocol (should never be called directly)

single protocol (should never be called directly)

Convenience method to be used by the ProtocolList Collection.

Returns

LoadBalancerService\Protocol
public Collection
# protocolList( )

a list of Protocol objects

a list of Protocol objects

Returns

Collection

Api

public LoadBalancerService\Algorithm
# algorithm( mixed $data = null )

single algorithm (should never be called directly)

single algorithm (should never be called directly)

convenience method used by the Collection factory

Returns

LoadBalancerService\Algorithm
public Collection
# algorithmList( )

a list of Algorithm objects

a list of Algorithm objects

Returns

Collection

Api

Methods inherited from OpenCloud\Common\Nova
Flavor(), FlavorList(), Request(), load_namespaces()
Methods inherited from OpenCloud\Common\Service
collection(), extensions(), getConnection(), getCurrentNamespace(), getResources(), limits(), name(), namespaces(), region(), request(), resolveResourceClass(), resource(), resourceList(), setConnection()
Methods inherited from OpenCloud\Common\Base
__set(), checkJsonError(), getHttpRequestObject(), getLogger(), makeQueryString(), populate(), setLogger(), setProperty()
Constants summary
string SERVICE_TYPE 'rax:load-balancer'
#
string SERVICE_OBJECT_CLASS 'LoadBalancer'
#
string URL_RESOURCE 'loadbalancers'
#
string JSON_ELEMENT 'loadBalancers'
#
Properties inherited from OpenCloud\Common\Service
$_namespaces, $conn
PHP OpenCloud API API documentation generated by ApiGen 2.8.0