Overview

Namespaces

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

Classes

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

Class Service

Cloud Monitoring service.

OpenCloud\Common\Base
Extended by OpenCloud\Common\Service\AbstractService implements OpenCloud\Common\Service\ServiceInterface
Extended by OpenCloud\Common\Service\CatalogService
Extended by OpenCloud\CloudMonitoring\Service
Namespace: OpenCloud\CloudMonitoring
Package: OpenCloud\CloudMonitoring
Link: http://docs.rackspace.com/cm/api/v1.0/cm-devguide/content/index.html
Located at OpenCloud/CloudMonitoring/Service.php
Methods summary
public OpenCloud\CloudMonitoring\Resource\Agent
# getAgent( string|null $id = null )

Get an agent.

Get an agent.

Parameters

$id
string|null
$id

Returns

OpenCloud\CloudMonitoring\Resource\Agent
public
# getAgents( )
public
# getAgentHost( mixed $id = null )
public
# getAgentTargets( )
public
# getAgentToken( mixed $id = null )
public
# getAgentTokens( )
public OpenCloud\Common\Collection
# getEntities( )

Return a collection of Entities.

Return a collection of Entities.

Returns

OpenCloud\Common\Collection
public
# createEntity( array $params )
public OpenCloud\CloudMonitoring\Resource\Entity
# getEntity( null $id = null )

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

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

Parameters

$id
null
$id

Returns

OpenCloud\CloudMonitoring\Resource\Entity
public OpenCloud\Common\Collection
# getCheckTypes( )

Get a collection of possible check types.

Get a collection of possible check types.

Returns

OpenCloud\Common\Collection
public OpenCloud\CloudMonitoring\Resource\CheckType
# getCheckType( null $id = null )

Get a particular check type.

Get a particular check type.

Parameters

$id
null
$id

Returns

OpenCloud\CloudMonitoring\Resource\CheckType
public mixed
# createNotification( array $params )

Create a new notification.

Create a new notification.

Parameters

$params
array
$params

Returns

mixed
public mixed
# testNotification( array $params )

Test the parameters of a notification before creating it.

Test the parameters of a notification before creating it.

Parameters

$params
array
$params

Returns

mixed
public OpenCloud\CloudMonitoring\Resource\Notification
# getNotification( null $id = null )

Get a particular notification.

Get a particular notification.

Parameters

$id
null
$id

Returns

OpenCloud\CloudMonitoring\Resource\Notification
public OpenCloud\Common\Collection
# getNotifications( )

Get a collection of Notifications.

Get a collection of Notifications.

Returns

OpenCloud\Common\Collection
public mixed
# createNotificationPlan( array $params )

Create a new notification plan.

Create a new notification plan.

Parameters

$params
array
$params

Returns

mixed
public OpenCloud\CloudMonitoring\Resource\NotificationPlan
# getNotificationPlan( null $id = null )

Get a particular notification plan.

Get a particular notification plan.

Parameters

$id
null
$id

Returns

OpenCloud\CloudMonitoring\Resource\NotificationPlan
public OpenCloud\Common\Collection
# getNotificationPlans( )

Get a collection of notification plans.

Get a collection of notification plans.

Returns

OpenCloud\Common\Collection
public OpenCloud\CloudMonitoring\Resource\NotificationType
# getNotificationType( null $id = null )

Get a particular notification type.

Get a particular notification type.

Parameters

$id
null
$id

Returns

OpenCloud\CloudMonitoring\Resource\NotificationType
public OpenCloud\Common\Collection
# getNotificationTypes( )

Get a collection of notification types.

Get a collection of notification types.

Returns

OpenCloud\Common\Collection
public OpenCloud\Common\Collection
# getMonitoringZones( )

Get a collection of monitoring zones.

Get a collection of monitoring zones.

Returns

OpenCloud\Common\Collection
public OpenCloud\CloudMonitoring\Resource\Zone
# getMonitoringZone( null $id = null )

Get a particular monitoring zone.

Get a particular monitoring zone.

Parameters

$id
null
$id

Returns

OpenCloud\CloudMonitoring\Resource\Zone
public object|false
# getChangelog( string|null $data = null )

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

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

Parameters

$data
string|null
$data

Returns

object|false
public object|false
# getViews( )

Returns

object|false
Methods inherited from OpenCloud\Common\Service\CatalogService
__construct(), getBaseUrl(), getExtensions(), getName(), getRegion(), getType(), getUrl(), getUrlType(), limits()
Methods inherited from OpenCloud\Common\Service\AbstractService
collection(), getClient(), getCurrentNamespace(), getEndpoint(), getNamespaces(), getResources(), resolveResourceClass(), resource(), resourceList(), setClient(), setEndpoint()
Methods inherited from OpenCloud\Common\Base
__call(), checkJsonError(), generateUuid(), getInstance(), getJsonHeader(), getLogger(), getProperty(), makeResourceIteratorOptions(), populate(), propertyExists(), setLogger(), setProperty(), stripNamespace(), toCamel(), toUnderscores()
Constants summary
string DEFAULT_TYPE 'rax:monitor'
#
string DEFAULT_NAME 'cloudMonitoring'
#
Constants inherited from OpenCloud\Common\Service\CatalogService
DEFAULT_URL_TYPE
Properties summary
protected boolean $regionless true
#

Indicates whether a service is "regionless" or not. Defaults to FALSE because nearly all services
are region-specific.

Indicates whether a service is "regionless" or not. Defaults to FALSE because nearly all services are region-specific.

protected array $resources array( 'Agent', 'AgentConnection', 'AgentHost', 'AgentHostInfo', 'AgentTarget', 'AgentToken', 'Alarm', 'Changelog', 'Check', 'CheckType', 'Entity', 'Metric', 'Notification', 'NotificationHistory', 'NotificationPlan', 'NotificationType', 'View', 'Zone' )
#

CloudMonitoring resources.

CloudMonitoring resources.

Properties inherited from OpenCloud\Common\Service\AbstractService
$client, $endpoint, $namespaces
Properties inherited from OpenCloud\Common\Base
$aliases
PHP OpenCloud API API documentation generated by ApiGen 2.8.0