Overview

Namespaces

  • OpenCloud
    • Autoscale
      • Resource
    • CloudMonitoring
      • Exception
      • Resource
    • Common
      • Collection
      • Constants
      • Exceptions
      • Http
        • Message
      • Identity
      • Log
      • Service
    • Compute
      • Constants
      • Exception
      • Resource
    • Database
      • Resource
    • DNS
      • Resource
    • LoadBalancer
      • Resource
    • ObjectStore
      • Constants
      • Exception
      • Resource
      • Upload
    • Orchestration
    • Queues
      • Exception
      • Resource
    • Volume
      • Resource
  • PHP

Classes

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

Class Service

The Rackspace Cloud Load Balancers

OpenCloud\Common\Base
Extended by OpenCloud\Common\Service\AbstractService
Extended by OpenCloud\Common\Service\NovaService
Extended by OpenCloud\LoadBalancer\Service
Namespace: OpenCloud\LoadBalancer
Located at OpenCloud/LoadBalancer/Service.php
Methods summary
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\Service\NovaService
flavor(), flavorList(), loadNamespaces()
Methods inherited from OpenCloud\Common\Service\AbstractService
__construct(), collection(), getBaseUrl(), getClient(), getCurrentNamespace(), getEndpoint(), getExtensions(), getName(), getRegion(), getResources(), getType(), getUrl(), getUrlType(), limits(), namespaces(), resolveResourceClass(), resource(), resourceList(), setClient()
Methods inherited from OpenCloud\Common\Base
__call(), checkJsonError(), generateUuid(), getLogger(), getProperty(), makeResourceIteratorOptions(), populate(), propertyExists(), setLogger(), setProperty(), stripNamespace(), toCamel(), toUnderscores()
Constants summary
string DEFAULT_NAME 'cloudLoadBalancers'
#
string DEFAULT_TYPE 'rax:load-balancer'
#
Constants inherited from OpenCloud\Common\Service\AbstractService
DEFAULT_REGION, DEFAULT_URL_TYPE
Properties inherited from OpenCloud\Common\Service\AbstractService
$client, $namespaces, $resources
PHP OpenCloud API API documentation generated by ApiGen 2.8.0