1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
<?php
/**
* Copyright 2012-2014 Rackspace US, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
namespace OpenCloud\CloudMonitoring;
use OpenCloud\Common\Service\CatalogService;
/**
* Cloud Monitoring service.
*
* @package OpenCloud\CloudMonitoring
* @link http://docs.rackspace.com/cm/api/v1.0/cm-devguide/content/index.html
*/
class Service extends CatalogService
{
const DEFAULT_TYPE = 'rax:monitor';
const DEFAULT_NAME = 'cloudMonitoring';
protected $regionless = true;
/**
* @var array CloudMonitoring resources.
*/
protected $resources = array(
'Agent',
'AgentConnection',
'AgentHost',
'AgentHostInfo',
'AgentTarget',
'AgentToken',
'Alarm',
'Changelog',
'Check',
'CheckType',
'Entity',
'Metric',
'Notification',
'NotificationHistory',
'NotificationPlan',
'NotificationType',
'View',
'Zone'
);
/**
* Get an agent.
*
* @param string|null $id
* @return \OpenCloud\CloudMonitoring\Resource\Agent
*/
public function getAgent($id = null)
{
return $this->resource('Agent', $id);
}
public function getAgents()
{
return $this->resourceList('Agent');
}
public function getAgentHost($agentId = null)
{
return $this->resource('AgentHost', null, $this->getAgent($agentId));
}
public function getAgentTargets()
{
return $this->resourceList('AgentTarget');
}
public function getAgentToken($id = null)
{
return $this->resource('AgentToken', $id);
}
public function getAgentTokens()
{
return $this->resourceList('AgentToken');
}
/**
* Return a collection of Entities.
*
* @return \OpenCloud\Common\Collection
*/
public function getEntities()
{
return $this->resourceList('Entity');
}
public function createEntity(array $params)
{
return $this->getEntity()->create($params);
}
/**
* Get either an empty object, or a populated one that exists on the API.
*
* @param null $id
* @return \OpenCloud\CloudMonitoring\Resource\Entity
*/
public function getEntity($id = null)
{
return $this->resource('Entity', $id);
}
/**
* Get a collection of possible check types.
*
* @return \OpenCloud\Common\Collection
*/
public function getCheckTypes()
{
return $this->resourceList('CheckType');
}
/**
* Get a particular check type.
*
* @param null $id
* @return \OpenCloud\CloudMonitoring\Resource\CheckType
*/
public function getCheckType($id = null)
{
return $this->resource('CheckType', $id);
}
/**
* Create a new notification.
*
* @param array $params
* @return
*/
public function createNotification(array $params)
{
return $this->getNotification($params)->create();
}
/**
* Test the parameters of a notification before creating it.
*
* @param array $params
* @return mixed
*/
public function testNotification(array $params)
{
return $this->getNotification()->testParams($params);
}
/**
* Get a particular notification.
*
* @param null $id
* @return \OpenCloud\CloudMonitoring\Resource\Notification
*/
public function getNotification($id = null)
{
return $this->resource('Notification', $id);
}
/**
* Get a collection of Notifications.
*
* @return \OpenCloud\Common\Collection
*/
public function getNotifications()
{
return $this->resourceList('Notification');
}
/**
* Create a new notification plan.
*
* @param array $params
* @return mixed
*/
public function createNotificationPlan(array $params)
{
return $this->getNotificationPlan()->create($params);
}
/**
* Get a particular notification plan.
*
* @param null $id
* @return \OpenCloud\CloudMonitoring\Resource\NotificationPlan
*/
public function getNotificationPlan($id = null)
{
return $this->resource('NotificationPlan', $id);
}
/**
* Get a collection of notification plans.
*
* @return \OpenCloud\Common\Collection
*/
public function getNotificationPlans()
{
return $this->resourceList('NotificationPlan');
}
/**
* Get a particular notification type.
*
* @param null $id
* @return \OpenCloud\CloudMonitoring\Resource\NotificationType
*/
public function getNotificationType($id = null)
{
return $this->resource('NotificationType', $id);
}
/**
* Get a collection of notification types.
*
* @return \OpenCloud\Common\Collection
*/
public function getNotificationTypes()
{
return $this->resourceList('NotificationType');
}
/**
* Get a collection of monitoring zones.
*
* @return \OpenCloud\Common\Collection
*/
public function getMonitoringZones()
{
return $this->resourceList('Zone');
}
/**
* Get a particular monitoring zone.
*
* @param null $id
* @return \OpenCloud\CloudMonitoring\Resource\Zone
*/
public function getMonitoringZone($id = null)
{
return $this->resource('Zone', $id);
}
/**
* Get a changelog - either a general one or one catered for a particular entity.
*
* @param string|null $data
* @return object|false
*/
public function getChangelog($data = null)
{
// Cater for Collections
if (is_object($data)) {
return $this->resource('Changelog', $data);
}
$url = $this->resource('Changelog')->getUrl();
if ($data) {
$url->setQuery(array('entityId' => (string) $data));
}
return $this->resourceList('Changelog', $url);
}
/**
* @return object|false
*/
public function getViews()
{
return $this->resourceList('View');
}
}