Package co.elastic.clients.elasticsearch.watcher

Class PutWatchRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<PutWatchRequest.Builder>

co.elastic.clients.elasticsearch.watcher.PutWatchRequest.Builder

All Implemented Interfaces:

WithJson<PutWatchRequest.Builder>, ObjectBuilder<PutWatchRequest>

Enclosing class:

PutWatchRequest

public static class PutWatchRequest.Builder
extends RequestBase.AbstractBuilder<PutWatchRequest.Builder>
implements ObjectBuilder<PutWatchRequest>

Builder for PutWatchRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final PutWatchRequest.Builder	actions(String key, Action value)	The list of actions that will be run if the condition matches.
final PutWatchRequest.Builder	actions(String key, Function<Action.Builder,ObjectBuilder<Action>> fn)	The list of actions that will be run if the condition matches.
final PutWatchRequest.Builder	actions(Map<String,Action> map)	The list of actions that will be run if the condition matches.
final PutWatchRequest.Builder	active(Boolean value)	The initial state of the watch.
PutWatchRequest	build()	Builds a PutWatchRequest.
final PutWatchRequest.Builder	condition(Condition value)	The condition that defines if the actions should be run.
final PutWatchRequest.Builder	condition(ConditionVariant value)	The condition that defines if the actions should be run.
final PutWatchRequest.Builder	condition(Function<Condition.Builder,ObjectBuilder<Condition>> fn)	The condition that defines if the actions should be run.
final PutWatchRequest.Builder	id(String value)	Required - The identifier for the watch.
final PutWatchRequest.Builder	ifPrimaryTerm(Long value)	only update the watch if the last operation that has changed the watch has the specified primary term
final PutWatchRequest.Builder	ifSeqNo(Long value)	only update the watch if the last operation that has changed the watch has the specified sequence number
final PutWatchRequest.Builder	input(Input value)	The input that defines the input that loads the data for the watch.
final PutWatchRequest.Builder	input(InputVariant value)	The input that defines the input that loads the data for the watch.
final PutWatchRequest.Builder	input(Function<Input.Builder,ObjectBuilder<Input>> fn)	The input that defines the input that loads the data for the watch.
final PutWatchRequest.Builder	metadata(String key, JsonData value)	Metadata JSON that will be copied into the history entries.
final PutWatchRequest.Builder	metadata(Map<String,JsonData> map)	Metadata JSON that will be copied into the history entries.
protected PutWatchRequest.Builder	self()
final PutWatchRequest.Builder	throttlePeriod(Time value)	The minimum time between actions being run.
final PutWatchRequest.Builder	throttlePeriod(Function<Time.Builder,ObjectBuilder<Time>> fn)	The minimum time between actions being run.
final PutWatchRequest.Builder	throttlePeriodInMillis(Long value)	Minimum time in milliseconds between actions being run.
final PutWatchRequest.Builder	transform(Transform value)	The transform that processes the watch payload to prepare it for the watch actions.
final PutWatchRequest.Builder	transform(TransformVariant value)	The transform that processes the watch payload to prepare it for the watch actions.
final PutWatchRequest.Builder	transform(Function<Transform.Builder,ObjectBuilder<Transform>> fn)	The transform that processes the watch payload to prepare it for the watch actions.
final PutWatchRequest.Builder	trigger(Trigger value)	The trigger that defines when the watch should run.
final PutWatchRequest.Builder	trigger(TriggerVariant value)	The trigger that defines when the watch should run.
final PutWatchRequest.Builder	trigger(Function<Trigger.Builder,ObjectBuilder<Trigger>> fn)	The trigger that defines when the watch should run.
final PutWatchRequest.Builder	version(Long value)	Explicit version number for concurrency control

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

actions

public final PutWatchRequest.Builder actions(Map<String,Action> map)

The list of actions that will be run if the condition matches.

API name: actions

Adds all entries of map to actions.

actions

public final PutWatchRequest.Builder actions(String key,
 Action value)

The list of actions that will be run if the condition matches.

API name: actions

Adds an entry to actions.

actions

public final PutWatchRequest.Builder actions(String key,
 Function<Action.Builder,ObjectBuilder<Action>> fn)

The list of actions that will be run if the condition matches.

API name: actions

Adds an entry to actions using a builder lambda.

active

public final PutWatchRequest.Builder active(@Nullable
 Boolean value)

The initial state of the watch. The default value is true, which means the watch is active by default.

API name: active

condition

public final PutWatchRequest.Builder condition(@Nullable
 Condition value)

The condition that defines if the actions should be run.

API name: condition

condition

public final PutWatchRequest.Builder condition(Function<Condition.Builder,ObjectBuilder<Condition>> fn)

The condition that defines if the actions should be run.

API name: condition

condition

public final PutWatchRequest.Builder condition(ConditionVariant value)

The condition that defines if the actions should be run.

API name: condition

id

public final PutWatchRequest.Builder id(String value)

Required - The identifier for the watch.

API name: id

ifPrimaryTerm

public final PutWatchRequest.Builder ifPrimaryTerm(@Nullable
 Long value)

only update the watch if the last operation that has changed the watch has the specified primary term

API name: if_primary_term

ifSeqNo

public final PutWatchRequest.Builder ifSeqNo(@Nullable
 Long value)

only update the watch if the last operation that has changed the watch has the specified sequence number

API name: if_seq_no

input

public final PutWatchRequest.Builder input(@Nullable
 Input value)

The input that defines the input that loads the data for the watch.

API name: input

input

public final PutWatchRequest.Builder input(Function<Input.Builder,ObjectBuilder<Input>> fn)

The input that defines the input that loads the data for the watch.

API name: input

input

public final PutWatchRequest.Builder input(InputVariant value)

The input that defines the input that loads the data for the watch.

API name: input

metadata

public final PutWatchRequest.Builder metadata(Map<String,JsonData> map)

Metadata JSON that will be copied into the history entries.

API name: metadata

Adds all entries of map to metadata.

metadata

public final PutWatchRequest.Builder metadata(String key,
 JsonData value)

Metadata JSON that will be copied into the history entries.

API name: metadata

Adds an entry to metadata.

throttlePeriod

public final PutWatchRequest.Builder throttlePeriod(@Nullable
 Time value)

The minimum time between actions being run. The default is 5 seconds. This default can be changed in the config file with the setting xpack.watcher.throttle.period.default_period. If both this value and the throttle_period_in_millis parameter are specified, Watcher uses the last parameter included in the request.

API name: throttle_period

throttlePeriod

public final PutWatchRequest.Builder throttlePeriod(Function<Time.Builder,ObjectBuilder<Time>> fn)

The minimum time between actions being run. The default is 5 seconds. This default can be changed in the config file with the setting xpack.watcher.throttle.period.default_period. If both this value and the throttle_period_in_millis parameter are specified, Watcher uses the last parameter included in the request.

API name: throttle_period

throttlePeriodInMillis

public final PutWatchRequest.Builder throttlePeriodInMillis(@Nullable
 Long value)

Minimum time in milliseconds between actions being run. Defaults to 5000. If both this value and the throttle_period parameter are specified, Watcher uses the last parameter included in the request.

API name: throttle_period_in_millis

transform

public final PutWatchRequest.Builder transform(@Nullable
 Transform value)

The transform that processes the watch payload to prepare it for the watch actions.

API name: transform

transform

public final PutWatchRequest.Builder transform(Function<Transform.Builder,ObjectBuilder<Transform>> fn)

The transform that processes the watch payload to prepare it for the watch actions.

API name: transform

transform

public final PutWatchRequest.Builder transform(TransformVariant value)

The transform that processes the watch payload to prepare it for the watch actions.

API name: transform

trigger

public final PutWatchRequest.Builder trigger(@Nullable
 Trigger value)

The trigger that defines when the watch should run.

API name: trigger

trigger

public final PutWatchRequest.Builder trigger(Function<Trigger.Builder,ObjectBuilder<Trigger>> fn)

The trigger that defines when the watch should run.

API name: trigger

trigger

public final PutWatchRequest.Builder trigger(TriggerVariant value)

The trigger that defines when the watch should run.

API name: trigger

version

public final PutWatchRequest.Builder version(@Nullable
 Long value)

Explicit version number for concurrency control

API name: version

self

protected PutWatchRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutWatchRequest.Builder>

build

public PutWatchRequest build()

Builds a PutWatchRequest.

Specified by:

build in interface ObjectBuilder<PutWatchRequest>

Throws:

NullPointerException - if some of the required fields are null.