org.openstack4j.model.telemetry

Interface Alarm

All Superinterfaces:

BasicResource, Buildable<AlarmBuilder>, IdEntity, ModelEntity, Serializable

All Known Implementing Classes:

CeilometerAlarm

public interface Alarm
extends ModelEntity, BasicResource, Buildable<AlarmBuilder>

An Alarm is triggered when a specificied rule is satisfied

Author:

Massimiliano Romano

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Alarm.AggregationMethod
static interface	Alarm.AggregationMetricByResourcesLookupRule
static interface	Alarm.AggregationMetricsByIdLookupRule
static interface	Alarm.AlarmChange
static interface	Alarm.AlarmTimeConstraint
static interface	Alarm.CombinationRule
static class	Alarm.ComparisonOperator
static interface	Alarm.GnocchiAggregationByMetricsThresholdRule
static interface	Alarm.GnocchiAggregationByResourcesThresholdRule
static interface	Alarm.GnocchiEvent
static interface	Alarm.GnocchiResourcesThresholdRule
static interface	Alarm.MetricOfResourceRule
static class	Alarm.Operator
static interface	Alarm.Query
static class	Alarm.Statistic
static interface	Alarm.ThresholdRule
static class	Alarm.Type The Alarm Type

Nested classes/interfaces inherited from interface org.openstack4j.common.Buildable

Buildable.Builder<T extends Buildable.Builder<T,M>,M extends Buildable<?>>

Method Summary

Modifier and Type	Method and Description
List<String>	getAlarmActions()
String	getAlarmId()
Alarm.CombinationRule	getCombinationRule()
Map<String,Object>	getCompositeRule()
String	getDescription()
Alarm.GnocchiAggregationByMetricsThresholdRule	getGnocchiAggregationByMetricsThresholdRule()
Alarm.GnocchiAggregationByResourcesThresholdRule	getGnocchiAggregationByResourcesThresholdRule()
Alarm.GnocchiResourcesThresholdRule	getGnocchiResourcesThresholdRule()
List<String>	getInsufficientDataActions()
String	getName()
List<String>	getOkActions()
String	getProjectId()
boolean	getRepeatActions()
String	getState()
String	getStateTimestamp()
Alarm.ThresholdRule	getThresholdRule()
String	getTimestamp()
Alarm.Type	getType()
String	getUserId()
boolean	isEnabled()
void	isEnabled(boolean newValue)
void	setAlarmActions(List<String> alarmActions)
void	setDescription(String description)
void	setGnocchiAggregationByMetricsThresholdRule(CeilometerAlarm.CeilometerGnocchiAggregationByMetricsThresholdRule ceilometerGnocchiAggregationByMetricsThresholdRule)
void	setGnocchiAggregationByResourcesThresholdRule(CeilometerAlarm.CeilometerGnocchiAggregationByResourcesThresholdRule ceilometerGnocchiAggregationByResourcesThresholdRule)
void	setGnocchiResourcesThresholdRule(CeilometerAlarm.CeilometerGnocchiResourcesThresholdRule ceilometerGnocchiResourcesThresholdRule)
void	setInsufficientDataActions(List<String> insufficientDataActions)
void	setName(String name) Sets the name for this resource
void	setOkActions(List<String> okActions)
void	setRepeateActions(Boolean repeatActions)
void	setThresholdRule(CeilometerAlarm.CeilometerThresholdRule tr)
void	setType(Alarm.Type type)
void	setUserId(String userId)

Methods inherited from interface org.openstack4j.model.common.IdEntity

getId, setId

Methods inherited from interface org.openstack4j.common.Buildable

toBuilder

Method Detail

getAlarmActions

List<String> getAlarmActions()

setAlarmActions

void setAlarmActions(List<String> alarmActions)

getAlarmId

String getAlarmId()

getDescription

String getDescription()

setDescription

void setDescription(String description)

isEnabled

boolean isEnabled()

isEnabled

void isEnabled(boolean newValue)

getInsufficientDataActions

List<String> getInsufficientDataActions()

setInsufficientDataActions

void setInsufficientDataActions(List<String> insufficientDataActions)

getName

String getName()

Specified by:

getName in interface BasicResource

Returns:

the unique name of the alarm

setName

void setName(String name)

Description copied from interface: BasicResource

Sets the name for this resource

Specified by:

setName in interface BasicResource

Parameters:

name - the name to set

getOkActions

List<String> getOkActions()

setOkActions

void setOkActions(List<String> okActions)

getProjectId

String getProjectId()

Returns:

the ID of the project/tenant that owns the resource

getRepeatActions

boolean getRepeatActions()

getState

String getState()

getStateTimestamp

String getStateTimestamp()

getThresholdRule

Alarm.ThresholdRule getThresholdRule()

setThresholdRule

void setThresholdRule(CeilometerAlarm.CeilometerThresholdRule tr)

getCombinationRule

Alarm.CombinationRule getCombinationRule()

getCompositeRule

Map<String,Object> getCompositeRule()

getGnocchiResourcesThresholdRule

Alarm.GnocchiResourcesThresholdRule getGnocchiResourcesThresholdRule()

setGnocchiResourcesThresholdRule

void setGnocchiResourcesThresholdRule(CeilometerAlarm.CeilometerGnocchiResourcesThresholdRule ceilometerGnocchiResourcesThresholdRule)

getGnocchiAggregationByMetricsThresholdRule

Alarm.GnocchiAggregationByMetricsThresholdRule getGnocchiAggregationByMetricsThresholdRule()

setGnocchiAggregationByMetricsThresholdRule

void setGnocchiAggregationByMetricsThresholdRule(CeilometerAlarm.CeilometerGnocchiAggregationByMetricsThresholdRule ceilometerGnocchiAggregationByMetricsThresholdRule)

getGnocchiAggregationByResourcesThresholdRule

Alarm.GnocchiAggregationByResourcesThresholdRule getGnocchiAggregationByResourcesThresholdRule()

setGnocchiAggregationByResourcesThresholdRule

void setGnocchiAggregationByResourcesThresholdRule(CeilometerAlarm.CeilometerGnocchiAggregationByResourcesThresholdRule ceilometerGnocchiAggregationByResourcesThresholdRule)

getTimestamp

String getTimestamp()

getType

Alarm.Type getType()

Returns:

the alarm type

setType

void setType(Alarm.Type type)

getUserId

String getUserId()

Returns:

The user id who last modified the resource

setUserId

void setUserId(String userId)

setRepeateActions

void setRepeateActions(Boolean repeatActions)