com.gooddata.sdk.model.md.dashboard

Class KpiAlert

java.lang.Object

com.gooddata.sdk.model.md.AbstractObj

com.gooddata.sdk.model.md.dashboard.KpiAlert

All Implemented Interfaces:

Obj, Queryable, Updatable, Serializable

public class KpiAlert
extends AbstractObj
implements Queryable, Updatable

Represents KPI alert set for some KPI on analytical dashboard.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.gooddata.sdk.model.md.AbstractObj

meta

Fields inherited from interface com.gooddata.sdk.model.md.Obj

CREATE_URI, CREATE_WITH_ID_URI, OBJ_URI, URI

Constructor Summary

Constructors

Constructor and Description
KpiAlert(String title, String kpiUri, String dashboardUri, double threshold, String triggerCondition, String filterContextUri) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getDashboardUri()
String	getFilterContextUri()
String	getKpiUri()
double	getThreshold()
String	getTriggerCondition()
boolean	wasTriggered()
KpiAlert	withTriggeredState(boolean wasTriggered) Creates new copy of KPI alert with a given triggered state changed.

Methods inherited from class com.gooddata.sdk.model.md.AbstractObj

getAuthor, getCategory, getContributor, getCreated, getFlags, getId, getIdentifier, getSummary, getTags, getTitle, getUpdated, getUri, isDeprecated, isLocked, isProduction, isSharedWithSomeone, isUnlisted, setCategory, setDeprecated, setFlags, setIdentifier, setLocked, setProduction, setSharedWithSomeone, setSummary, setTags, setTitle, setUnlisted, toString, uris

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.gooddata.sdk.model.md.Obj

getUri

Constructor Detail

KpiAlert

public KpiAlert(String title,
                String kpiUri,
                String dashboardUri,
                double threshold,
                String triggerCondition,
                String filterContextUri)

Constructor.

Parameters:

title - KPI alert title

kpiUri - URI of the KPI for which the alert is defined

dashboardUri - URI of the KPI where the KPI alert is located

threshold - KPI alert threshold

triggerCondition - condition for triggering KPI alert

filterContextUri - URI of filter context used for computation of KPI alert (optional)

Method Detail

wasTriggered

public boolean wasTriggered()

Returns:

if the KPI alert was already triggered

getThreshold

public double getThreshold()

Returns:

KPI value threshold for triggering KPI alert

getFilterContextUri

public String getFilterContextUri()

Returns:

filters used for computation of KPI alert

getTriggerCondition

public String getTriggerCondition()

Returns:

condition for triggering KPI alert (e.g. "above_threshold")

getDashboardUri

public String getDashboardUri()

Returns:

URI of the analytical dashboard where the alert is located

getKpiUri

public String getKpiUri()

Returns:

URI of the KPI for which is the alert configured

withTriggeredState

public KpiAlert withTriggeredState(boolean wasTriggered)

Creates new copy of KPI alert with a given triggered state changed.

Parameters:

wasTriggered - triggered state

Returns:

new KPI alert