IMonitoringService.EvaluateAlarmExampleAsync Method

IMonitoringServiceEvaluateAlarmExampleAsync Method

This API is preliminary and subject to change.

Evaluate the template of a single alarm example.

Namespace: net.openstack.Providers.Rackspace
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c

Syntax

C++

Copy

Task<BoundAlarmExample> EvaluateAlarmExampleAsync(
	AlarmExampleId alarmExampleId,
	IDictionary<string, Object> exampleParameters,
	CancellationToken cancellationToken
)

Function EvaluateAlarmExampleAsync ( 
	alarmExampleId As AlarmExampleId,
	exampleParameters As IDictionary(Of String, Object),
	cancellationToken As CancellationToken
) As Task(Of BoundAlarmExample)

Task<BoundAlarmExample^>^ EvaluateAlarmExampleAsync(
	AlarmExampleId^ alarmExampleId, 
	IDictionary<String^, Object^>^ exampleParameters, 
	CancellationToken cancellationToken
)

abstract EvaluateAlarmExampleAsync : 
        alarmExampleId : AlarmExampleId * 
        exampleParameters : IDictionary<string, Object> * 
        cancellationToken : CancellationToken -> Task<BoundAlarmExample>

Parameters

alarmExampleId: Type: net.openstack.Providers.Rackspace.Objects.MonitoringAlarmExampleId
The alarm example ID. This is obtained from AlarmExample.Id.
exampleParameters: Type: System.Collections.GenericIDictionaryString, Object
A dictionary containing the values to insert in the alarm example. The dictionary should contain a key/value pair for each field described in Fields for the alarm example.
cancellationToken: Type: System.ThreadingCancellationToken
The CancellationToken that the task will observe.

Return Value

Type: TaskBoundAlarmExample
A Task object representing the asynchronous operation. When the task completes successfully, the Result property will contain a BoundAlarmExample object containing the evaluated alarm example.

Exceptions

Exception	Condition
ArgumentNullException	If alarmExampleId is . -or- If exampleParameters is .
ArgumentException	If exampleParameters contains any empty keys.
WebException	If the REST request does not return successfully.

Exception

Condition

ArgumentNullException

If alarmExampleId is .

-or-

If exampleParameters is .

ArgumentException

If exampleParameters contains any empty keys.

WebException

If the REST request does not return successfully.

Version Information