Documentation

Node extends PersistentResource
in package

Application

The nodes defined by the load balancer are responsible for servicing the requests received through the load balancer's virtual IP. By default, the load balancer employs a basic health check that ensures the node is listening on its defined port. The node is checked at the time of addition and at regular intervals as defined by the load balancer health check configuration. If a back-end node is not listening on its port or does not meet the conditions of the defined active health check for the load balancer, then the load balancer will not forward connections and its status will be listed as "OFFLINE". Only nodes that are in an "ONLINE" status will receive and be able to service traffic from the load balancer.

All nodes have an associated status that indicates whether the node is ONLINE, OFFLINE, or DRAINING. Only nodes that are in ONLINE status will receive and be able to service traffic from the load balancer. The OFFLINE status represents a node that cannot accept or service traffic. A node in DRAINING status represents a node that stops the traffic manager from sending any additional new connections to the node, but honors established sessions. If the traffic manager receives a request and session persistence requires that the node is used, the traffic manager will use it. The status is determined by the passive or active health monitors.

If the WEIGHTED_ROUND_ROBIN load balancer algorithm mode is selected, then the caller should assign the relevant weights to the node as part of the weight attribute of the node element. When the algorithm of the load balancer is changed to WEIGHTED_ROUND_ROBIN and the nodes do not already have an assigned weight, the service will automatically set the weight to "1" for all nodes.

One or more secondary nodes can be added to a specified load balancer so that if all the primary nodes fail, traffic can be redirected to secondary nodes. The type attribute allows configuring the node as either PRIMARY or SECONDARY.

PATCH_CONTENT_TYPE = OpenCloudCommonConstantsMime::JSON_PATCH
$address : string: IP address or domain name for the node.
$condition : string: Condition for the node, which determines its role within the load balancer.
$createKeys : mixed
$id : mixed
$port : int: Port number for the service you are load balancing.
$status : string: Current state of the node. Can either be ONLINE, OFFLINE or DRAINING.
$type : string: Type of node to add:
$weight : int: Weight of node to add. If the WEIGHTED_ROUND_ROBIN load balancer algorithm mode is selected, then the user should assign the relevant weight to the node using the weight attribute for the node. Must be an integer from 1 to 100.
$aliases : array<string|int, mixed>: The aliases configure for the properties of the instance.
$json_collection_name : mixed
$json_name : mixed
$metadata : Metadata
$parent : BaseResource
$service : ServiceInterface
$url_resource : mixed
$logger : LoggerInterface: The logger instance
$properties : array<string|int, mixed>: Holds all the properties added by overloading.
__call() : mixed: Intercept non-existent method calls for dynamic getter/setter functionality.
__construct() : mixed
checkExtension() : bool: Check whether an extension is valid
checkJsonError() : mixed: Checks the most recent JSON operation for errors.
create() : Response: Create a new resource
createJson() : object: Provides JSON for create request body
createUrl() : Url
delete() : Response: Delete this resource
findLink() : bool: Find a resource link based on a type
generateUuid() : mixed
getClient() : ClientInterface: Convenience method to return the service's client
getInstance() : static
getLogger() : LoggerInterface: Returns the Logger object.
getMetadata() : Metadata
getParent() : mixed
getService() : ServiceInterface
getUrl() : mixed: Get this resource's URL
hasLogger() : bool
id() : mixed
jsonCollectionElement() : string: Returns the nested keys that could (rarely) prefix collection items. For example:
jsonCollectionName() : string: Returns the top-level key for collection responses
jsonName() : mixed: Returns the top-level key for the returned response JSON document
makeResourceIteratorOptions() : mixed
metadata() : Metadata: Returns a Metadata item
metadataList() : PaginatedIterator: Returns a paginated collection of metadata
name() : string: returns the Node name
parseResponse() : mixed: Parse a HTTP response for the required content
populate() : mixed: Populates the current object based on an unknown data type.
refresh() : Response: Refresh the state of a resource
refreshFromLocationUrl() : mixed: Given a `location` URL, refresh this resource
region() : mixed
resourceName() : mixed: Returns the URI path for this resource
setLogger() : $this: Sets the logger.
setMetadata() : $this
setParent() : self
setService() : PersistentObject
status() : string
stripNamespace() : mixed
toCamel() : mixed: Convert a string to camelCase format.
toUnderscores() : mixed: Convert string to underscore format.
update() : Response: Update a resource
url() : mixed
waitFor() : mixed: A method to repeatedly poll the API resource, waiting for an eventual state change
generateJsonPatch() : string: Generates a JSON Patch representation and return its
getAlias() : string: Returns the alias configured for the given key. If no alias exists it returns the original key.
getJsonHeader() : mixed
getPatchHeaders() : mixed
getProperty() : mixed: Grab value out of the data array.
getUpdateablePropertiesAsArray() : mixed: Returns the object's properties as an array
noCreate() : mixed
noDelete() : mixed
noUpdate() : mixed
primaryKeyField() : string: Returns the primary key field for the object
propertyExists() : bool: Basic check to see whether property exists.
recursivelyAliasPropertyValue() : mixed: Returns the given property value's alias, if configured; Else, the unchanged property value is returned. If the given property value is an array or an instance of \stdClass, it is aliases recursively.
refreshFromParent() : mixed: Causes resource to refresh based on parent's URL
setProperty() : mixed: We can set a property under three conditions:
updateJson() : mixed: Provides JSON for update request body
checkAttributePrefix() : bool: Checks the attribute $property and only permits it if the prefix is in the specified $prefixes array
isAccessible() : bool: Does the property exist in the object variable list (i.e. does it have public or protected visibility?)

PATCH_CONTENT_TYPE


    public
    mixed
    PATCH_CONTENT_TYPE
    = OpenCloudCommonConstantsMime::JSON_PATCH

$address

IP address or domain name for the node.


    public
        string
    $address

$condition

Condition for the node, which determines its role within the load balancer.


    public
        string
    $condition

$createKeys


    public
        mixed
    $createKeys
     = array('address', 'port', 'condition', 'type', 'weight')

$id


    public
        mixed
    $id

$port

Port number for the service you are load balancing.


    public
        int
    $port

$status

Current state of the node. Can either be ONLINE, OFFLINE or DRAINING.


    public
        string
    $status

$type

Type of node to add:


    public
        string
    $type

PRIMARY: Nodes defined as PRIMARY are in the normal rotation to receive traffic from the load balancer.
SECONDARY: Nodes defined as SECONDARY are only in the rotation to receive traffic from the load balancer when all the primary nodes fail.

$weight

Weight of node to add. If the WEIGHTED_ROUND_ROBIN load balancer algorithm mode is selected, then the user should assign the relevant weight to the node using the weight attribute for the node. Must be an integer from 1 to 100.


    public
        int
    $weight

$aliases

The aliases configure for the properties of the instance.


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

$json_collection_name


    protected
    static    mixed
    $json_collection_name
     = 'nodes'

$json_name


    protected
    static    mixed
    $json_name
     = false

$metadata


    protected
        Metadata
    $metadata

$parent


    protected
        BaseResource
    $parent

$service


    protected
        ServiceInterface
    $service

$url_resource


    protected
    static    mixed
    $url_resource
     = 'nodes'

$logger

The logger instance


    private
        LoggerInterface
    $logger

$properties

Holds all the properties added by overloading.


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

__call()

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


    public
                __call( $method,  $args) : mixed

Parameters

$method :
$args :

Return values

mixed —

__construct()


    public
                __construct(ServiceInterface $service[,  $data = null ]) : mixed

Parameters

$service : ServiceInterface: The service that this resource belongs to
$data : = null: $data

Return values

mixed —

checkExtension()

Check whether an extension is valid


    public
                checkExtension(mixed $alias) : bool

Parameters

$alias : mixed: The extension name

Return values

bool —

checkJsonError()

Checks the most recent JSON operation for errors.


    public
            static    checkJsonError() : mixed

Return values

mixed —

create()

Create a new resource


    public
                create([array<string|int, mixed> $params = array() ]) : Response

Parameters

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

Return values

Response —

createJson()

Provides JSON for create request body


    public
                createJson() : object

Return values

object —

createUrl()


    public
                createUrl() : Url

Return values

Url —

delete()

Delete this resource


    public
                delete() : Response

Return values

Response —

findLink()

Find a resource link based on a type


    public
                findLink([string $type = 'self' ]) : bool

Parameters

$type : string = 'self'

Return values

bool —

generateUuid()


    public
            static    generateUuid() : mixed

Return values

mixed —

getClient()

Convenience method to return the service's client


    public
                getClient() : ClientInterface

Return values

ClientInterface —

getInstance()


    public
            static    getInstance() : static

Return values

static —

getLogger()

Returns the Logger object.


    public
                getLogger() : LoggerInterface

Return values

LoggerInterface —

getMetadata()


    public
                getMetadata() : Metadata

Return values

Metadata —

getParent()


    public
                getParent() : mixed

Return values

mixed —

getService()


    public
                getService() : ServiceInterface

Return values

ServiceInterface —

getUrl()

Get this resource's URL


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

Parameters

$path : null = null: URI path to add on
$query : array<string|int, mixed> = array(): Query to add on

Return values

mixed —

hasLogger()


    public
                hasLogger() : bool

Return values

bool —

id()


    public
                id() : mixed

Return values

mixed —

jsonCollectionElement()

Returns the nested keys that could (rarely) prefix collection items. For example:


    public
            static    jsonCollectionElement() : string

{ "keypairs": [ { "keypair": { "fingerprint": "...", "name": "key1", "public_key": "..." } }, { "keypair": { "fingerprint": "...", "name": "key2", "public_key": "..." } } ] }

In the above example, "keypairs" would be the $json_collection_name and "keypair" would be the $json_collection_element

Return values

string —

jsonCollectionName()

Returns the top-level key for collection responses


    public
            static    jsonCollectionName() : string

Return values

string —

jsonName()

Returns the top-level key for the returned response JSON document


    public
            static    jsonName() : mixed

Return values

mixed —

makeResourceIteratorOptions()


    public
                makeResourceIteratorOptions(mixed $resource) : mixed

Parameters

$resource : mixed

Return values

mixed —

metadata()

Returns a Metadata item


    public
                metadata([mixed $data = null ]) : Metadata

Parameters

$data : mixed = null

Return values

Metadata —

metadataList()

Returns a paginated collection of metadata


    public
                metadataList() : PaginatedIterator

Return values

PaginatedIterator —

name()

returns the Node name


    public
                name() : string

Return values

string —

parseResponse()

Parse a HTTP response for the required content


    public
                parseResponse(Response $response) : mixed

Parameters

$response : Response

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 —

refresh()

Refresh the state of a resource


    public
                refresh([null $id = null ][, null $url = null ]) : Response

Parameters

$id : null = null
$url : null = null

Return values

Response —

refreshFromLocationUrl()

Given a `location` URL, refresh this resource


    public
                refreshFromLocationUrl( $url) : mixed

Parameters

$url :

Return values

mixed —

region()


    public
                region() : mixed

Return values

mixed —

resourceName()

Returns the URI path for this resource


    public
            static    resourceName() : mixed

Return values

mixed —

setLogger()

Sets the logger.


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

Parameters

$logger : LoggerInterface = null

Return values

$this —

setMetadata()


    public
                setMetadata(mixed $data) : $this

Parameters

$data : mixed

Return values

$this —

setParent()


    public
                setParent(BaseResource $parent) : self

Parameters

$parent : BaseResource

Return values

self —

setService()


    public
                setService(ServiceInterface $service) : PersistentObject

Parameters

$service : ServiceInterface

Return values

PersistentObject —

status()


    public
                status() : string

Return values

string —

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 —

update()

Update a resource


    public
                update([array<string|int, mixed> $params = array() ]) : Response

Parameters

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

Return values

Response —

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 —

waitFor()

A method to repeatedly poll the API resource, waiting for an eventual state change


    public
                waitFor([null $state = null ][, null $timeout = null ][, null $callback = null ][, null $interval = null ]) : mixed

Parameters

$state : null = null: The expected state of the resource
$timeout : null = null: The maximum timeout to wait
$callback : null = null: The callback to use to check the state
$interval : null = null: How long between each refresh request

Return values

mixed —

generateJsonPatch()

Generates a JSON Patch representation and return its


    protected
                generateJsonPatch(mixed $updatedProperties) : string

Parameters

$updatedProperties : mixed: Properties of the resource to update

Return values

string —

JSON Patch representation for updates

getAlias()

Returns the alias configured for the given key. If no alias exists it returns the original key.


    protected
                getAlias(string $key) : string

Parameters

$key : string

Return values

string —

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 —

getUpdateablePropertiesAsArray()

Returns the object's properties as an array


    protected
                getUpdateablePropertiesAsArray() : mixed

Return values

mixed —

noCreate()


    protected
                noCreate() : mixed

Return values

mixed —

noDelete()


    protected
                noDelete() : mixed

Return values

mixed —

noUpdate()


    protected
                noUpdate() : mixed

Return values

mixed —

primaryKeyField()

Returns the primary key field for the object


    protected
                primaryKeyField() : string

Return values

string —

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 —

recursivelyAliasPropertyValue()

Returns the given property value's alias, if configured; Else, the unchanged property value is returned. If the given property value is an array or an instance of \stdClass, it is aliases recursively.


    protected
                recursivelyAliasPropertyValue(mixed $propertyValue) : mixed

Parameters

$propertyValue : mixed: Array or \stdClass instance to alias

Return values

mixed —

Property value, aliased recursively

refreshFromParent()

Causes resource to refresh based on parent's URL


    protected
                refreshFromParent() : mixed

Return values

mixed —

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 —

updateJson()

Provides JSON for update request body


    protected
                updateJson([mixed $params = array() ]) : mixed

Parameters

$params : mixed = array()

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 —

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 —