org.openstack4j.openstack.telemetry.domain

Class CeilometerAlarm

java.lang.Object

org.openstack4j.openstack.telemetry.domain.CeilometerAlarm

All Implemented Interfaces:

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

public class CeilometerAlarm
extends Object
implements Alarm

An Alarm is triggered when a specificied rule is satisfied

Author:

Massimiliano Romano

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CeilometerAlarm.AlarmConcreteBuilder
static class	CeilometerAlarm.CeilometerCombinationRule
static class	CeilometerAlarm.CeilometerGnocchiAggregationByMetricsThresholdRule
static class	CeilometerAlarm.CeilometerGnocchiAggregationByResourcesThresholdRule
static class	CeilometerAlarm.CeilometerGnocchiResourcesThresholdRule
static class	CeilometerAlarm.CeilometerQuery
static class	CeilometerAlarm.CeilometerThresholdRule

Nested classes/interfaces inherited from interface org.openstack4j.model.telemetry.Alarm

Alarm.AggregationMethod, Alarm.AggregationMetricByResourcesLookupRule, Alarm.AggregationMetricsByIdLookupRule, Alarm.AlarmChange, Alarm.AlarmTimeConstraint, Alarm.CombinationRule, Alarm.ComparisonOperator, Alarm.GnocchiAggregationByMetricsThresholdRule, Alarm.GnocchiAggregationByResourcesThresholdRule, Alarm.GnocchiEvent, Alarm.GnocchiResourcesThresholdRule, Alarm.MetricOfResourceRule, Alarm.Operator, Alarm.Query, Alarm.Statistic, Alarm.ThresholdRule, Alarm.Type

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

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

Constructor Summary

Constructors

Constructor and Description
CeilometerAlarm()

Method Summary

Modifier and Type	Method and Description
static AlarmBuilder	builder()
List<String>	getAlarmActions()
String	getAlarmId()
Alarm.CombinationRule	getCombinationRule()
Map<String,Object>	getCompositeRule()
String	getDescription()
Alarm.GnocchiAggregationByMetricsThresholdRule	getGnocchiAggregationByMetricsThresholdRule()
Alarm.GnocchiAggregationByResourcesThresholdRule	getGnocchiAggregationByResourcesThresholdRule()
Alarm.GnocchiResourcesThresholdRule	getGnocchiResourcesThresholdRule()
String	getId()
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	setId(String id) Sets the identifier for this resource.
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)
AlarmBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CeilometerAlarm

public CeilometerAlarm()

Method Detail

getName

public String getName()

Specified by:

getName in interface BasicResource

Specified by:

getName in interface Alarm

Returns:

the unique name of the alarm

getProjectId

public String getProjectId()

Specified by:

getProjectId in interface Alarm

Returns:

the ID of the project/tenant that owns the resource

getType

public Alarm.Type getType()

Specified by:

getType in interface Alarm

Returns:

the alarm type

getUserId

public String getUserId()

Specified by:

getUserId in interface Alarm

Returns:

The user id who last modified the resource

toString

public String toString()

Overrides:

toString in class Object

getAlarmActions

public List<String> getAlarmActions()

Specified by:

getAlarmActions in interface Alarm

getAlarmId

public String getAlarmId()

Specified by:

getAlarmId in interface Alarm

getDescription

public String getDescription()

Specified by:

getDescription in interface Alarm

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Alarm

isEnabled

public void isEnabled(boolean newValue)

Specified by:

isEnabled in interface Alarm

getInsufficientDataActions

public List<String> getInsufficientDataActions()

Specified by:

getInsufficientDataActions in interface Alarm

getOkActions

public List<String> getOkActions()

Specified by:

getOkActions in interface Alarm

getRepeatActions

public boolean getRepeatActions()

Specified by:

getRepeatActions in interface Alarm

getState

public String getState()

Specified by:

getState in interface Alarm

getStateTimestamp

public String getStateTimestamp()

Specified by:

getStateTimestamp in interface Alarm

getThresholdRule

public Alarm.ThresholdRule getThresholdRule()

Specified by:

getThresholdRule in interface Alarm

getCombinationRule

public Alarm.CombinationRule getCombinationRule()

Specified by:

getCombinationRule in interface Alarm

getCompositeRule

public Map<String,Object> getCompositeRule()

Specified by:

getCompositeRule in interface Alarm

getGnocchiResourcesThresholdRule

public Alarm.GnocchiResourcesThresholdRule getGnocchiResourcesThresholdRule()

Specified by:

getGnocchiResourcesThresholdRule in interface Alarm

getGnocchiAggregationByMetricsThresholdRule

public Alarm.GnocchiAggregationByMetricsThresholdRule getGnocchiAggregationByMetricsThresholdRule()

Specified by:

getGnocchiAggregationByMetricsThresholdRule in interface Alarm

getGnocchiAggregationByResourcesThresholdRule

public Alarm.GnocchiAggregationByResourcesThresholdRule getGnocchiAggregationByResourcesThresholdRule()

Specified by:

getGnocchiAggregationByResourcesThresholdRule in interface Alarm

getTimestamp

public String getTimestamp()

Specified by:

getTimestamp in interface Alarm

builder

public static AlarmBuilder builder()

setName

public void setName(String name)

Sets the name for this resource

Specified by:

setName in interface BasicResource

Specified by:

setName in interface Alarm

Parameters:

name - the name to set

setType

public void setType(Alarm.Type type)

Specified by:

setType in interface Alarm

setUserId

public void setUserId(String userId)

Specified by:

setUserId in interface Alarm

setAlarmActions

public void setAlarmActions(List<String> alarmActions)

Specified by:

setAlarmActions in interface Alarm

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface Alarm

setInsufficientDataActions

public void setInsufficientDataActions(List<String> insufficientDataActions)

Specified by:

setInsufficientDataActions in interface Alarm

setOkActions

public void setOkActions(List<String> okActions)

Specified by:

setOkActions in interface Alarm

setRepeateActions

public void setRepeateActions(Boolean repeatActions)

Specified by:

setRepeateActions in interface Alarm

getId

public String getId()

Specified by:

getId in interface IdEntity

Returns:

the identifier for this resource

setId

public void setId(String id)

Description copied from interface: IdEntity

Sets the identifier for this resource. Note: creating a new resource should not have the idenfier set since OpenStack will assign one on the create call

Specified by:

setId in interface IdEntity

Parameters:

id - the identifier

setThresholdRule

public void setThresholdRule(CeilometerAlarm.CeilometerThresholdRule tr)

Specified by:

setThresholdRule in interface Alarm

setGnocchiAggregationByResourcesThresholdRule

public void setGnocchiAggregationByResourcesThresholdRule(CeilometerAlarm.CeilometerGnocchiAggregationByResourcesThresholdRule ceilometerGnocchiAggregationByResourcesThresholdRule)

Specified by:

setGnocchiAggregationByResourcesThresholdRule in interface Alarm

setGnocchiAggregationByMetricsThresholdRule

public void setGnocchiAggregationByMetricsThresholdRule(CeilometerAlarm.CeilometerGnocchiAggregationByMetricsThresholdRule ceilometerGnocchiAggregationByMetricsThresholdRule)

Specified by:

setGnocchiAggregationByMetricsThresholdRule in interface Alarm

setGnocchiResourcesThresholdRule

public void setGnocchiResourcesThresholdRule(CeilometerAlarm.CeilometerGnocchiResourcesThresholdRule ceilometerGnocchiResourcesThresholdRule)

Specified by:

setGnocchiResourcesThresholdRule in interface Alarm

toBuilder

public AlarmBuilder toBuilder()

Specified by:

toBuilder in interface Buildable<AlarmBuilder>