org.jclouds.cloudwatch.features

Interface AlarmApi

@Beta
public interface AlarmApi

Provides access to Amazon CloudWatch via the Query API

Author:

Jeremy Whitlock

See Also:

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(Iterable<String> alarmNames) Deletes all specified alarms.
void	disable(Iterable<String> alarmNames) Disables actions for the specified alarms.
void	enable(Iterable<String> alarmNames) Enables actions for the specified alarms.
PagedIterable<Alarm>	list() Return all alarms.
PagedIterable<Alarm>	list(ListAlarmsOptions options) Return all alarms based on the options query
IterableWithMarker<Alarm>	listAt(String nextToken) Return a single page of alarms based on the options query
com.google.common.collect.FluentIterable<Alarm>	listForMetric(ListAlarmsForMetric options) Return alarms all alarms for a single metric.
PagedIterable<AlarmHistoryItem>	listHistory() Return all history for all alarms.
PagedIterable<AlarmHistoryItem>	listHistory(ListAlarmHistoryOptions options) Return all history based on the options query
IterableWithMarker<AlarmHistoryItem>	listHistoryAt(String nextToken) Return a single page of history for the specified alarm.
void	save(SaveAlarmOptions options) Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric.
void	setState(String alarmName, String stateReason, String stateReasonData, Alarm.State state) Temporarily sets the state of an alarm.

Method Detail

delete

@Named(value="DeleteAlarms")
void delete(Iterable<String> alarmNames)

Deletes all specified alarms.

Note

In the event of an error, no alarms are deleted.

Parameters:

alarmNames - the list of alarms to delete

listHistory

@Named(value="DescribeAlarmHistory")
PagedIterable<AlarmHistoryItem> listHistory()

Return all history for all alarms.

Returns:

the response object

listHistory

@Named(value="DescribeAlarmHistory")
PagedIterable<AlarmHistoryItem> listHistory(ListAlarmHistoryOptions options)

Return all history based on the options query

Returns:

the response object

listHistoryAt

@Named(value="DescribeAlarmHistory")
IterableWithMarker<AlarmHistoryItem> listHistoryAt(String nextToken)

Return a single page of history for the specified alarm.

Parameters:

nextToken - the token corresponding with the data you want to get

Returns:

the response object

list

@Named(value="DescribeAlarms")
PagedIterable<Alarm> list()

Return all alarms.

Returns:

the response object

list

@Named(value="DescribeAlarms")
PagedIterable<Alarm> list(ListAlarmsOptions options)

Return all alarms based on the options query

Parameters:

options - the options describing the alarms query

Returns:

the response object

listAt

@Named(value="DescribeAlarms")
IterableWithMarker<Alarm> listAt(String nextToken)

Return a single page of alarms based on the options query

Parameters:

nextToken - the token corresponding with the data you want to get

Returns:

the response object

listForMetric

@Named(value="DescribeAlarmsForMetric")
com.google.common.collect.FluentIterable<Alarm> listForMetric(ListAlarmsForMetric options)

Return alarms all alarms for a single metric.

Parameters:

options - the options describing the alarms for metric query

Returns:

the response object

disable

@Named(value="DisableAlarmActions")
void disable(Iterable<String> alarmNames)

Disables actions for the specified alarms.

Parameters:

alarmNames - the list of alarms to disable

enable

@Named(value="EnableAlarmActions")
void enable(Iterable<String> alarmNames)

Enables actions for the specified alarms.

Parameters:

alarmNames - the list of alarms to enable

save

@Named(value="PutMetricAlarm")
void save(SaveAlarmOptions options)

Creates or updates an alarm and associates it with the specified Amazon CloudWatch metric.

Parameters:

options - the options describing the metric alarm to create/update

setState

@Named(value="SetAlarmState")
void setState(String alarmName,
                  String stateReason,
                  @Nullable
                  String stateReasonData,
                  Alarm.State state)

Temporarily sets the state of an alarm.

Parameters:

alarmName - the descriptive name for the alarm

stateReason - the reason that this alarm is set to this specific state (in human-readable text format)

stateReasonData - the reason that this alarm is set to this specific state (in machine-readable JSON format)

state - the value of the state