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
-
Method Summary
Modifier and TypeMethodDescriptionactionModes
(String key, ActionExecutionMode value) Determines how to handle the watch actions as part of the watch execution.Determines how to handle the watch actions as part of the watch execution.alternativeInput
(String key, JsonData value) When present, the watch uses this object as a payload instead of executing its own input.alternativeInput
(Map<String, JsonData> map) When present, the watch uses this object as a payload instead of executing its own input.build()
Builds aExecuteWatchRequest
.Defines whether the watch runs in debug mode.Identifier for the watch.ignoreCondition
(Boolean value) When set totrue
, the watch execution uses the always condition.recordExecution
(Boolean value) When set totrue
, the watch record representing the watch execution result is persisted to the.watcher-history
index for the current time.protected ExecuteWatchRequest.Builder
self()
simulatedActions
(SimulatedActions value) API name:simulated_actions
API name:simulated_actions
triggerData
(ScheduleTriggerEvent value) This structure is parsed as the data of the trigger event that will be used during the watch executionThis structure is parsed as the data of the trigger event that will be used during the watch executionWhen present, this watch is used instead of the one specified in the request.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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
actionModes
Determines how to handle the watch actions as part of the watch execution.API name:
action_modes
Adds all entries of
map
toactionModes
. -
actionModes
Determines how to handle the watch actions as part of the watch execution.API name:
action_modes
Adds an entry to
actionModes
. -
alternativeInput
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
toalternativeInput
. -
alternativeInput
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
Defines whether the watch runs in debug mode.API name:
debug
-
id
Identifier for the watch.API name:
id
-
ignoreCondition
When set totrue
, the watch execution uses the always condition. This can also be specified as an HTTP parameter.API name:
ignore_condition
-
recordExecution
When set totrue
, 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
API name:simulated_actions
-
simulatedActions
public final ExecuteWatchRequest.Builder simulatedActions(Function<SimulatedActions.Builder, ObjectBuilder<SimulatedActions>> fn) API name:simulated_actions
-
triggerData
This structure is parsed as the data of the trigger event that will be used during the watch executionAPI 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 executionAPI name:
trigger_data
-
watch
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
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
- Specified by:
self
in classRequestBase.AbstractBuilder<ExecuteWatchRequest.Builder>
-
build
Builds aExecuteWatchRequest
.- Specified by:
build
in interfaceObjectBuilder<ExecuteWatchRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-