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 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()
String	getDescription()
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	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()

getAlarmId

String getAlarmId()

getDescription

String getDescription()

isEnabled

boolean isEnabled()

isEnabled

void isEnabled(boolean newValue)

getInsufficientDataActions

List<String> getInsufficientDataActions()

getName

String getName()

Specified by:

getName in interface BasicResource

Returns:

the unique name of the alarm

getOkActions

List<String> getOkActions()

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()

getTimestamp

String getTimestamp()

getType

Alarm.Type getType()

Returns:

the alarm type

getUserId

String getUserId()

Returns:

The user id who last modified the resource

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

setType

void setType(Alarm.Type type)

setUserId

void setUserId(String userId)

setAlarmActions

void setAlarmActions(List<String> alarmActions)

setDescription

void setDescription(String description)

setInsufficientDataActions

void setInsufficientDataActions(List<String> insufficientDataActions)

setOkActions

void setOkActions(List<String> okActions)

setRepeateActions

void setRepeateActions(Boolean repeatActions)

setThresholdRule

void setThresholdRule(CeilometerAlarm.CeilometerThresholdRule tr)