Documentation

Service extends CatalogService
in package

OpenCloud

CloudMonitoring

Cloud Monitoring service.

DEFAULT_NAME


    public
    mixed
    DEFAULT_NAME
    = 'cloudMonitoring'

DEFAULT_TYPE


    public
    mixed
    DEFAULT_TYPE
    = 'rax:monitor'

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
     = true

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('Agent', 'AgentConnection', 'AgentHost', 'AgentHostInfo', 'AgentTarget', 'AgentToken', 'Alarm', 'Changelog', 'Check', 'CheckType', 'Entity', 'Metric', 'Notification', 'NotificationHistory', 'NotificationPlan', 'NotificationType', 'View', 'Zone')

CloudMonitoring resources.

$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 —

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 —

createEntity()


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

Parameters

$params : array<string|int, mixed>

Return values

mixed —

createNotification()

Create a new notification.


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

Parameters

$params : array<string|int, mixed>

Return values

mixed —

createNotificationPlan()

Create a new notification plan.


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

Parameters

$params : array<string|int, mixed>

Return values

mixed —

generateUuid()


    public
            static    generateUuid() : mixed

Return values

mixed —

getAgent()

Get an agent.


    public
                getAgent([string|null $id = null ]) : Agent

Parameters

$id : string|null = null

Return values

Agent —

getAgentHost()


    public
                getAgentHost([mixed $agentId = null ]) : mixed

Parameters

$agentId : mixed = null

Return values

mixed —

getAgents()


    public
                getAgents() : mixed

Return values

mixed —

getAgentTargets()


    public
                getAgentTargets() : mixed

Return values

mixed —

getAgentToken()


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

Parameters

$id : mixed = null

Return values

mixed —

getAgentTokens()


    public
                getAgentTokens() : mixed

Return values

mixed —

getBaseUrl()

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


    public
                getBaseUrl() : Url

Return values

Url —

getChangelog()

Get a changelog - either a general one or one catered for a particular entity.


    public
                getChangelog([string|null $data = null ]) : object|false

Parameters

$data : string|null = null

Return values

object|false —

getCheckType()

Get a particular check type.


    public
                getCheckType([null $id = null ]) : CheckType

Parameters

$id : null = null

Return values

CheckType —

getCheckTypes()

Get a collection of possible check types.


    public
                getCheckTypes() : Collection

Return values

Collection —

getClient()


    public
                getClient() : Client

Return values

Client —

getEndpoint()


    public
                getEndpoint() : Endpoint

Return values

Endpoint —

getEntities()

Return a collection of Entities.


    public
                getEntities() : Collection

Return values

Collection —

getEntity()

Get either an empty object, or a populated one that exists on the API.


    public
                getEntity([null $id = null ]) : Entity

Parameters

$id : null = null

Return values

Entity —

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 —

getMonitoringZone()

Get a particular monitoring zone.


    public
                getMonitoringZone([null $id = null ]) : Zone

Parameters

$id : null = null

Return values

Zone —

getMonitoringZones()

Get a collection of monitoring zones.


    public
                getMonitoringZones() : Collection

Return values

Collection —

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> —

getNotification()

Get a particular notification.


    public
                getNotification([null $id = null ]) : Notification

Parameters

$id : null = null

Return values

Notification —

getNotificationPlan()

Get a particular notification plan.


    public
                getNotificationPlan([null $id = null ]) : NotificationPlan

Parameters

$id : null = null

Return values

NotificationPlan —

getNotificationPlans()

Get a collection of notification plans.


    public
                getNotificationPlans() : Collection

Return values

Collection —

getNotifications()

Get a collection of Notifications.


    public
                getNotifications() : Collection

Return values

Collection —

getNotificationType()

Get a particular notification type.


    public
                getNotificationType([null $id = null ]) : NotificationType

Parameters

$id : null = null

Return values

NotificationType —

getNotificationTypes()

Get a collection of notification types.


    public
                getNotificationTypes() : Collection

Return values

Collection —

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 —

getViews()


    public
                getViews() : object|false

Return values

object|false —

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

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 —

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 —

testNotification()

Test the parameters of a notification before creating it.


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

Parameters

$params : array<string|int, 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 —

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 —