Module org.elasticsearch.xcore

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

Class Watch

java.lang.Object

org.elasticsearch.xpack.core.watcher.watch.Watch

All Implemented Interfaces:

ToXContent, ToXContentObject

public class Watch
extends Object
implements ToXContentObject

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INCLUDE_STATUS_KEY
static final String	INDEX

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Watch(String id, Trigger trigger, ExecutableInput<? extends Input,? extends Input.Result> input, ExecutableCondition condition, ExecutableTransform<? extends Transform,? extends Transform.Result> transform, TimeValue throttlePeriod, List<ActionWrapper> actions, Map<String,Object> metadata, WatchStatus status, long sourceSeqNo, long sourcePrimaryTerm)

Method Summary

Modifier and Type	Method	Description
boolean	ack(ZonedDateTime now, String... actionIds)	Acks this watch.
boolean	acked(String actionId)
List<ActionWrapper>	actions()
ExecutableCondition	condition()
boolean	equals(Object o)
long	getSourcePrimaryTerm()	The primary term of the document that was used to create this watch, SequenceNumbers.UNASSIGNED_PRIMARY_TERM if the watch wasn't read from a document
long	getSourceSeqNo()	The sequence number of the document that was used to create this watch, SequenceNumbers.UNASSIGNED_SEQ_NO if the watch wasn't read from a document
int	hashCode()
String	id()
ExecutableInput<? extends Input,? extends Input.Result>	input()
Map<String,Object>	metadata()
boolean	setState(boolean active, ZonedDateTime now)	Sets the state of this watch to in/active
WatchStatus	status()
TimeValue	throttlePeriod()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ExecutableTransform<? extends Transform,? extends Transform.Result>	transform()
Trigger	trigger()

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_STATUS_KEY

public static final String INCLUDE_STATUS_KEY

See Also:

• Constant Field Values

INDEX

public static final String INDEX

See Also:

• Constant Field Values

Constructor Details

Watch

public Watch(String id,
 Trigger trigger,
 ExecutableInput<? extends Input,? extends Input.Result> input,
 ExecutableCondition condition,
 @Nullable
 ExecutableTransform<? extends Transform,? extends Transform.Result> transform,
 @Nullable
 TimeValue throttlePeriod,
 List<ActionWrapper> actions,
 @Nullable
 Map<String,Object> metadata,
 WatchStatus status,
 long sourceSeqNo,
 long sourcePrimaryTerm)

Method Details

id

public String id()

trigger

public Trigger trigger()

input

public ExecutableInput<? extends Input,? extends Input.Result> input()

condition

public ExecutableCondition condition()

transform

public ExecutableTransform<? extends Transform,? extends Transform.Result> transform()

throttlePeriod

public TimeValue throttlePeriod()

actions

public List<ActionWrapper> actions()

metadata

public Map<String,Object> metadata()

status

public WatchStatus status()

getSourceSeqNo

public long getSourceSeqNo()

The sequence number of the document that was used to create this watch, SequenceNumbers.UNASSIGNED_SEQ_NO if the watch wasn't read from a document

getSourcePrimaryTerm

public long getSourcePrimaryTerm()

The primary term of the document that was used to create this watch, SequenceNumbers.UNASSIGNED_PRIMARY_TERM if the watch wasn't read from a document

setState

public boolean setState(boolean active,
 ZonedDateTime now)

Sets the state of this watch to in/active

Returns:

true if the status of this watch changed, false otherwise.

ack

public boolean ack(ZonedDateTime now,
 String... actionIds)

Acks this watch.

Returns:

true if the status of this watch changed, false otherwise.

acked

public boolean acked(String actionId)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException