Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.watcher.watch

Class WatchStatus

java.lang.Object

org.elasticsearch.xpack.core.watcher.watch.WatchStatus

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class WatchStatus
extends Object
implements ToXContentObject, Writeable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WatchStatus.Field
static class	WatchStatus.State

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INCLUDE_STATE

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
WatchStatus(long version, WatchStatus.State state, ExecutionState executionState, ZonedDateTime lastChecked, ZonedDateTime lastMetCondition, Map<String,ActionStatus> actions, Map<String,String> headers)
WatchStatus(ZonedDateTime now, Map<String,ActionStatus> actions)
WatchStatus(StreamInput in)

Method Summary

Modifier and Type	Method	Description
ActionStatus	actionStatus(String actionId)
boolean	checked()
boolean	equals(Object o)
ExecutionState	getExecutionState()
Map<String,String>	getHeaders()
int	hashCode()
ZonedDateTime	lastChecked()
ZonedDateTime	lastMetCondition()
void	onActionResult(String actionId, ZonedDateTime timestamp, Action.Result result)
void	onCheck(boolean metCondition, ZonedDateTime timestamp)	Called whenever an watch is checked, ie.
static WatchStatus	parse(String watchId, WatcherXContentParser parser)
void	setExecutionState(ExecutionState executionState)
void	setHeaders(Map<String,String> headers)
WatchStatus.State	state()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
long	version()
void	version(long version)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

INCLUDE_STATE

public static final String INCLUDE_STATE

See Also:

• Constant Field Values

Constructor Details

WatchStatus

public WatchStatus(StreamInput in)
            throws IOException

Throws:

IOException

WatchStatus

public WatchStatus(ZonedDateTime now,
 Map<String,ActionStatus> actions)

WatchStatus

public WatchStatus(long version,
 WatchStatus.State state,
 ExecutionState executionState,
 ZonedDateTime lastChecked,
 ZonedDateTime lastMetCondition,
 Map<String,ActionStatus> actions,
 Map<String,String> headers)

Method Details

state

public WatchStatus.State state()

checked

public boolean checked()

lastChecked

public ZonedDateTime lastChecked()

lastMetCondition

public ZonedDateTime lastMetCondition()

actionStatus

public ActionStatus actionStatus(String actionId)

version

public long version()

version

public void version(long version)

setExecutionState

public void setExecutionState(ExecutionState executionState)

getExecutionState

public ExecutionState getExecutionState()

getHeaders

public Map<String,String> getHeaders()

setHeaders

public void setHeaders(Map<String,String> headers)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

onCheck

public void onCheck(boolean metCondition,
 ZonedDateTime timestamp)

Called whenever an watch is checked, ie. the condition of the watch is evaluated to see if the watch should be executed.

Parameters:

metCondition - indicates whether the watch's condition was met.

onActionResult

public void onActionResult(String actionId,
 ZonedDateTime timestamp,
 Action.Result result)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

parse

public static WatchStatus parse(String watchId,
 WatcherXContentParser parser)
                         throws IOException

Throws:

IOException