Package co.elastic.clients.elasticsearch.watcher

Class ExecuteWatchRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.watcher.ExecuteWatchRequest.Builder

All Implemented Interfaces:

WithJson<ExecuteWatchRequest.Builder>, ObjectBuilder<ExecuteWatchRequest>

Enclosing class:

ExecuteWatchRequest

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

Builder for ExecuteWatchRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final ExecuteWatchRequest.Builder	actionModes(String key, ActionExecutionMode value)	Determines how to handle the watch actions as part of the watch execution.
final ExecuteWatchRequest.Builder	actionModes(Map<String,ActionExecutionMode> map)	Determines how to handle the watch actions as part of the watch execution.
final ExecuteWatchRequest.Builder	alternativeInput(String key, JsonData value)	When present, the watch uses this object as a payload instead of executing its own input.
final ExecuteWatchRequest.Builder	alternativeInput(Map<String,JsonData> map)	When present, the watch uses this object as a payload instead of executing its own input.
ExecuteWatchRequest	build()	Builds a ExecuteWatchRequest.
final ExecuteWatchRequest.Builder	debug(Boolean value)	Defines whether the watch runs in debug mode.
final ExecuteWatchRequest.Builder	id(String value)	Identifier for the watch.
final ExecuteWatchRequest.Builder	ignoreCondition(Boolean value)	When set to true, the watch execution uses the always condition.
final ExecuteWatchRequest.Builder	recordExecution(Boolean value)	When set to true, the watch record representing the watch execution result is persisted to the .watcher-history index for the current time.
protected ExecuteWatchRequest.Builder	self()
final ExecuteWatchRequest.Builder	simulatedActions(SimulatedActions value)	API name: simulated_actions
final ExecuteWatchRequest.Builder	simulatedActions(Function<SimulatedActions.Builder,ObjectBuilder<SimulatedActions>> fn)	API name: simulated_actions
final ExecuteWatchRequest.Builder	triggerData(ScheduleTriggerEvent value)	This structure is parsed as the data of the trigger event that will be used during the watch execution
final ExecuteWatchRequest.Builder	triggerData(Function<ScheduleTriggerEvent.Builder,ObjectBuilder<ScheduleTriggerEvent>> fn)	This structure is parsed as the data of the trigger event that will be used during the watch execution
final ExecuteWatchRequest.Builder	watch(Watch value)	When present, this watch is used instead of the one specified in the request.
final ExecuteWatchRequest.Builder	watch(Function<Watch.Builder,ObjectBuilder<Watch>> fn)	When present, this watch is used instead of the one specified in the request.

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

actionModes

public final ExecuteWatchRequest.Builder actionModes(Map<String,ActionExecutionMode> map)

Determines how to handle the watch actions as part of the watch execution.

API name: action_modes

Adds all entries of map to actionModes.

actionModes

public final ExecuteWatchRequest.Builder actionModes(String key,
 ActionExecutionMode value)

Determines how to handle the watch actions as part of the watch execution.

API name: action_modes

Adds an entry to actionModes.

alternativeInput

public final ExecuteWatchRequest.Builder alternativeInput(Map<String,JsonData> map)

When present, the watch uses this object as a payload instead of executing its own input.

API name: alternative_input

Adds all entries of map to alternativeInput.

alternativeInput

public final ExecuteWatchRequest.Builder alternativeInput(String key,
 JsonData value)

When present, the watch uses this object as a payload instead of executing its own input.

API name: alternative_input

Adds an entry to alternativeInput.

debug

public final ExecuteWatchRequest.Builder debug(@Nullable
 Boolean value)

Defines whether the watch runs in debug mode.

API name: debug

id

public final ExecuteWatchRequest.Builder id(@Nullable
 String value)

Identifier for the watch.

API name: id

ignoreCondition

public final ExecuteWatchRequest.Builder ignoreCondition(@Nullable
 Boolean value)

When set to true, the watch execution uses the always condition. This can also be specified as an HTTP parameter.

API name: ignore_condition

recordExecution

public final ExecuteWatchRequest.Builder recordExecution(@Nullable
 Boolean value)

When set to true, the watch record representing the watch execution result is persisted to the .watcher-history index for the current time. In addition, the status of the watch is updated, possibly throttling subsequent executions. This can also be specified as an HTTP parameter.

API name: record_execution

simulatedActions

public final ExecuteWatchRequest.Builder simulatedActions(@Nullable
 SimulatedActions value)

API name: simulated_actions

simulatedActions

public final ExecuteWatchRequest.Builder simulatedActions(Function<SimulatedActions.Builder,ObjectBuilder<SimulatedActions>> fn)

API name: simulated_actions

triggerData

public final ExecuteWatchRequest.Builder triggerData(@Nullable
 ScheduleTriggerEvent value)

This structure is parsed as the data of the trigger event that will be used during the watch execution

API name: trigger_data

triggerData

public final ExecuteWatchRequest.Builder triggerData(Function<ScheduleTriggerEvent.Builder,ObjectBuilder<ScheduleTriggerEvent>> fn)

This structure is parsed as the data of the trigger event that will be used during the watch execution

API name: trigger_data

watch

public final ExecuteWatchRequest.Builder watch(@Nullable
 Watch value)

When present, this watch is used instead of the one specified in the request. This watch is not persisted to the index and record_execution cannot be set.

API name: watch

watch

public final ExecuteWatchRequest.Builder watch(Function<Watch.Builder,ObjectBuilder<Watch>> fn)

When present, this watch is used instead of the one specified in the request. This watch is not persisted to the index and record_execution cannot be set.

API name: watch

self

protected ExecuteWatchRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ExecuteWatchRequest.Builder>

build

public ExecuteWatchRequest build()

Builds a ExecuteWatchRequest.

Specified by:

build in interface ObjectBuilder<ExecuteWatchRequest>

Throws:

NullPointerException - if some of the required fields are null.