org.jclouds.cloudwatch.options

Class SaveAlarmOptions

java.lang.Object

org.jclouds.http.options.BaseHttpRequestOptions

org.jclouds.cloudwatch.options.SaveAlarmOptions

All Implemented Interfaces:

HttpRequestOptions

@Beta
public class SaveAlarmOptions
extends BaseHttpRequestOptions

Options used to create/update an alarm.

Author:

Jeremy Whitlock

See Also:

Field Summary

Fields inherited from class org.jclouds.http.options.BaseHttpRequestOptions

formParameters, headers, pathSuffix, payload, queryParameters

Constructor Summary

Constructors

Constructor and Description
SaveAlarmOptions()

Method Summary

Methods

Modifier and Type	Method and Description
SaveAlarmOptions	actionsEnabled(boolean actionsEnabled) Indicates whether or not actions should be executed during any changes to the alarm's state.
SaveAlarmOptions	alarmAction(String alarmAction) The action to execute when this alarm transitions into an ALARM state from any other state.
SaveAlarmOptions	alarmActions(Set<String> alarmActions) The list of actions to execute when this alarm transitions into an ALARM state from any other state.
SaveAlarmOptions	alarmDescription(String alarmDescription) The description of the alarm.
SaveAlarmOptions	alarmName(String alarmName) The name of the alarm.
SaveAlarmOptions	comparisonOperator(ComparisonOperator comparisonOperator) The arithmetic operation to use when comparing the specified statistic and threshold.
SaveAlarmOptions	dimension(Dimension dimension) The dimension for the alarm's associated metric.
SaveAlarmOptions	dimensions(Set<Dimension> dimensions) The dimensions for the alarm's associated metric.
SaveAlarmOptions	evaluationPeriods(int evaluationPeriods) The number of periods over which data is compared to the specified threshold.
SaveAlarmOptions	insufficientDataAction(String insufficientDataAction) The actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state.
SaveAlarmOptions	insufficientDataActions(Set<String> insufficientDataActions) The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state.
SaveAlarmOptions	metricName(String metricName) The name for the alarm's associated metric.
SaveAlarmOptions	namespace(String namespace) The namespace for the alarm's associated metric.
SaveAlarmOptions	okAction(String okAction) The action to execute when this alarm transitions into an OK state from any other state.
SaveAlarmOptions	okActions(Set<String> okActions) The list of actions to execute when this alarm transitions into an OK state from any other state.
SaveAlarmOptions	period(int period) The period in seconds over which the specified statistic is applied.
SaveAlarmOptions	statistic(Statistics statistic) The statistic to apply to the alarm's associated metric.
SaveAlarmOptions	threshold(double threshold) The value against which the specified statistic is compared.
SaveAlarmOptions	unit(Unit unit) The unit for the alarm's associated metric.

Methods inherited from class org.jclouds.http.options.BaseHttpRequestOptions

buildFormParameters, buildPathSuffix, buildQueryParameters, buildRequestHeaders, buildStringPayload, equals, getFirstFormOrNull, getFirstHeaderOrNull, getFirstQueryOrNull, hashCode, replaceHeader, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SaveAlarmOptions

public SaveAlarmOptions()

Method Detail

actionsEnabled

public SaveAlarmOptions actionsEnabled(boolean actionsEnabled)

Indicates whether or not actions should be executed during any changes to the alarm's state.

Parameters:

actionsEnabled - indicates whether or not actions should be executed during any changes to the alarm's state

Returns:

this SaveAlarmOptions object

alarmActions

public SaveAlarmOptions alarmActions(Set<String> alarmActions)

The list of actions to execute when this alarm transitions into an ALARM state from any other state.

Parameters:

alarmActions - the list of actions to execute when this alarm transitions into an ALARM state from any other state

Returns:

this SaveAlarmOptions object

alarmAction

public SaveAlarmOptions alarmAction(String alarmAction)

The action to execute when this alarm transitions into an ALARM state from any other state.

Parameters:

alarmAction - the actions to execute when this alarm transitions into an ALARM state from any other state

Returns:

this SaveAlarmOptions object

alarmDescription

public SaveAlarmOptions alarmDescription(String alarmDescription)

The description of the alarm.

Parameters:

alarmDescription - the description of the alarm

Returns:

this SaveAlarmOptions object

alarmName

public SaveAlarmOptions alarmName(String alarmName)

The name of the alarm.

Parameters:

alarmName - the name of the alarm

Returns:

this SaveAlarmOptions object

comparisonOperator

public SaveAlarmOptions comparisonOperator(ComparisonOperator comparisonOperator)

The arithmetic operation to use when comparing the specified statistic and threshold.

Parameters:

comparisonOperator - the arithmetic operation to use when comparing the specified statistic and threshold

Returns:

this SaveAlarmOptions object

dimensions

public SaveAlarmOptions dimensions(Set<Dimension> dimensions)

The dimensions for the alarm's associated metric.

Parameters:

dimensions - the dimensions for the alarm's associated metric

Returns:

this SaveAlarmOptions object

dimension

public SaveAlarmOptions dimension(Dimension dimension)

The dimension for the alarm's associated metric.

Parameters:

dimension - the dimension for the alarm's associated metric

Returns:

this SaveAlarmOptions object

evaluationPeriods

public SaveAlarmOptions evaluationPeriods(int evaluationPeriods)

The number of periods over which data is compared to the specified threshold.

Parameters:

evaluationPeriods - the number of periods over which data is compared to the specified threshold

Returns:

this SaveAlarmOptions object

insufficientDataActions

public SaveAlarmOptions insufficientDataActions(Set<String> insufficientDataActions)

The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state.

Parameters:

insufficientDataActions - the list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state

Returns:

this SaveAlarmOptions object

insufficientDataAction

public SaveAlarmOptions insufficientDataAction(String insufficientDataAction)

The actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state.

Parameters:

insufficientDataAction - the action to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state

Returns:

this SaveAlarmOptions object

metricName

public SaveAlarmOptions metricName(String metricName)

The name for the alarm's associated metric.

Parameters:

metricName - the name for the alarm's associated metric

Returns:

this SaveAlarmOptions object

namespace

public SaveAlarmOptions namespace(String namespace)

The namespace for the alarm's associated metric.

Parameters:

namespace - the namespace for the alarm's associated metric

Returns:

this SaveAlarmOptions object

okActions

public SaveAlarmOptions okActions(Set<String> okActions)

The list of actions to execute when this alarm transitions into an OK state from any other state.

Parameters:

okActions - the list of actions to execute when this alarm transitions into an OK state from any other state

Returns:

this SaveAlarmOptions object

okAction

public SaveAlarmOptions okAction(String okAction)

The action to execute when this alarm transitions into an OK state from any other state.

Parameters:

okAction - the action to execute when this alarm transitions into an OK state from any other state

Returns:

this SaveAlarmOptions object

period

public SaveAlarmOptions period(int period)

The period in seconds over which the specified statistic is applied.

Parameters:

period - the period in seconds over which the specified statistic is applied

Returns:

this SaveAlarmOptions object

statistic

public SaveAlarmOptions statistic(Statistics statistic)

The statistic to apply to the alarm's associated metric.

Parameters:

statistic - the statistic to apply to the alarm's associated metric

Returns:

this SaveAlarmOptions object

threshold

public SaveAlarmOptions threshold(double threshold)

The value against which the specified statistic is compared.

Parameters:

threshold - the value against which the specified statistic is compared

Returns:

this SaveAlarmOptions object

unit

public SaveAlarmOptions unit(Unit unit)

The unit for the alarm's associated metric.

Parameters:

unit - the unit for the alarm's associated metric

Returns:

this SaveAlarmOptions object