com.exalead.cloudview.alerting.v2

Interface Alert

All Known Implementing Classes:

AlertImpl

public interface Alert

Method Summary

Modifier and Type	Method and Description
long	getCreationTimeInMS() Returns a timestamp in milliseconds representing when this alert has been created.
java.lang.String	getDescription() Returns the description of this alert.
java.lang.Iterable<java.lang.String>	getGroups() Returns the groups of this alert.
long	getId() Returns the identifier of this alert.
java.lang.String	getKey() Returns the key of this alert.
long	getLastExecutionNbEntries() Returns the number of entries last time the alert was executed.
long	getLastExecutionTimeInMS() Returns a timestamp in milliseconds representing the last time the alert was executed, 0 if the alert was never executed.
java.lang.String	getName() Returns the name of this alert.
java.lang.String	getQueryArgs() Returns Mashup-API query arguments, in form/url-encoded form.
java.lang.String	getUILevelQueryArgs() Returns Mashup-UI query arguments in form/url-encoded form, matching the queryArgs.
java.lang.String	getUsername() Returns alert's creator user name.

Method Detail

getId

long getId()

Returns the identifier of this alert.

Returns:

the identifier of this alert

getKey

java.lang.String getKey()

Returns the key of this alert.

Returns:

the key of this alert

getName

java.lang.String getName()

Returns the name of this alert.

Returns:

the name of this alert

getDescription

java.lang.String getDescription()

Returns the description of this alert.

Returns:

the description of this alert

getGroups

java.lang.Iterable<java.lang.String> getGroups()

Returns the groups of this alert.

Returns:

the groups of this alert

getUsername

java.lang.String getUsername()

Returns alert's creator user name.

Returns:

alert's creator user name

getQueryArgs

java.lang.String getQueryArgs()

Returns Mashup-API query arguments, in form/url-encoded form.

Returns:

Mashup-API query arguments, in form/url-encoded form.

getUILevelQueryArgs

java.lang.String getUILevelQueryArgs()

Returns Mashup-UI query arguments in form/url-encoded form, matching the queryArgs. Often used to generate links to the Mashup UI. It may be null.

Returns:

the query arguments or null

getCreationTimeInMS

long getCreationTimeInMS()

Returns a timestamp in milliseconds representing when this alert has been created.

Returns:

a timestamp in milliseconds representing when this alert has been created

getLastExecutionTimeInMS

long getLastExecutionTimeInMS()

Returns a timestamp in milliseconds representing the last time the alert was executed, 0 if the alert was never executed.

Returns:

a timestamp in milliseconds representing the last time the alert was executed, 0 if the alert was never executed

getLastExecutionNbEntries

long getLastExecutionNbEntries()

Returns the number of entries last time the alert was executed.

Returns:

the number of entries last time the alert was executed