Class ExecuteWatchRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<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 WithJsonObjectBuilderBase<ExecuteWatchRequest.Builder> implements ObjectBuilder<ExecuteWatchRequest>
Builder for
ExecuteWatchRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description ExecuteWatchRequest.Builder
actionModes(java.lang.String key, ActionExecutionMode value)
Determines how to handle the watch actions as part of the watch execution.ExecuteWatchRequest.Builder
actionModes(java.util.Map<java.lang.String,ActionExecutionMode> map)
Determines how to handle the watch actions as part of the watch execution.ExecuteWatchRequest.Builder
alternativeInput(java.lang.String key, JsonData value)
When present, the watch uses this object as a payload instead of executing its own input.ExecuteWatchRequest.Builder
alternativeInput(java.util.Map<java.lang.String,JsonData> map)
When present, the watch uses this object as a payload instead of executing its own input.ExecuteWatchRequest
build()
Builds aExecuteWatchRequest
.ExecuteWatchRequest.Builder
debug(java.lang.Boolean value)
Defines whether the watch runs in debug mode.ExecuteWatchRequest.Builder
id(java.lang.String value)
Identifier for the watch.ExecuteWatchRequest.Builder
ignoreCondition(java.lang.Boolean value)
When set totrue
, the watch execution uses the always condition.ExecuteWatchRequest.Builder
recordExecution(java.lang.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()
ExecuteWatchRequest.Builder
simulatedActions(SimulatedActions value)
API name:simulated_actions
ExecuteWatchRequest.Builder
simulatedActions(java.util.function.Function<SimulatedActions.Builder,ObjectBuilder<SimulatedActions>> fn)
API name:simulated_actions
ExecuteWatchRequest.Builder
triggerData(ScheduleTriggerEvent value)
This structure is parsed as the data of the trigger event that will be used during the watch executionExecuteWatchRequest.Builder
triggerData(java.util.function.Function<ScheduleTriggerEvent.Builder,ObjectBuilder<ScheduleTriggerEvent>> fn)
This structure is parsed as the data of the trigger event that will be used during the watch executionExecuteWatchRequest.Builder
watch(Watch value)
When present, this watch is used instead of the one specified in the request.ExecuteWatchRequest.Builder
watch(java.util.function.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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
actionModes
public final ExecuteWatchRequest.Builder actionModes(java.util.Map<java.lang.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
toactionModes
. -
actionModes
public final ExecuteWatchRequest.Builder actionModes(java.lang.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(java.util.Map<java.lang.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
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(java.util.function.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(java.util.function.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
public final ExecuteWatchRequest.Builder watch(java.util.function.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
- Specified by:
self
in classWithJsonObjectBuilderBase<ExecuteWatchRequest.Builder>
-
build
Builds aExecuteWatchRequest
.- Specified by:
build
in interfaceObjectBuilder<ExecuteWatchRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-