Class RolloverRequest.Builder
java.lang.Object
co.elastic.clients.elasticsearch.indices.RolloverRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<RolloverRequest>
- Enclosing class:
- RolloverRequest
public static class RolloverRequest.Builder extends java.lang.Object implements ObjectBuilder<RolloverRequest>
Builder for
RolloverRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description RolloverRequest.Builder
alias(java.lang.String value)
Required - The name of the alias to rolloverRolloverRequest.Builder
aliases(java.lang.String key, java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)
Setaliases(Map)
to a singleton map.RolloverRequest.Builder
aliases(java.util.Map<java.lang.String,Alias> value)
API name:aliases
RolloverRequest
build()
Builds aRolloverRequest
.RolloverRequest.Builder
conditions(RolloverConditions value)
API name:conditions
RolloverRequest.Builder
conditions(java.util.function.Function<RolloverConditions.Builder,ObjectBuilder<RolloverConditions>> fn)
API name:conditions
RolloverRequest.Builder
dryRun(java.lang.Boolean value)
If set to true the rollover action will only be validated but not actually performed even if a condition matches.RolloverRequest.Builder
includeTypeName(java.lang.Boolean value)
Whether a type should be included in the body of the mappings.RolloverRequest.Builder
mappings(jakarta.json.JsonValue value)
API name:mappings
RolloverRequest.Builder
masterTimeout(java.lang.String value)
Specify timeout for connection to masterRolloverRequest.Builder
newIndex(java.lang.String value)
The name of the rollover indexRolloverRequest.Builder
putAliases(java.lang.String key, Alias value)
Add a key/value toaliases(Map)
, creating the map if needed.RolloverRequest.Builder
putAliases(java.lang.String key, java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)
Add a key/value toaliases(Map)
, creating the map if needed.RolloverRequest.Builder
putSettings(java.lang.String key, JsonData value)
Add a key/value tosettings(Map)
, creating the map if needed.RolloverRequest.Builder
settings(java.util.Map<java.lang.String,JsonData> value)
API name:settings
RolloverRequest.Builder
timeout(java.lang.String value)
Explicit operation timeoutRolloverRequest.Builder
waitForActiveShards(jakarta.json.JsonValue value)
Set the number of active shards to wait for on the newly created rollover index before the operation returns.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
-
alias
Required - The name of the alias to rolloverAPI name:
alias
-
newIndex
The name of the rollover indexAPI name:
new_index
-
dryRun
If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is falseAPI name:
dry_run
-
includeTypeName
Whether a type should be included in the body of the mappings.API name:
include_type_name
-
masterTimeout
Specify timeout for connection to masterAPI name:
master_timeout
-
timeout
Explicit operation timeoutAPI name:
timeout
-
waitForActiveShards
Set the number of active shards to wait for on the newly created rollover index before the operation returns.API name:
wait_for_active_shards
-
aliases
API name:aliases
-
putAliases
Add a key/value toaliases(Map)
, creating the map if needed. -
aliases
public RolloverRequest.Builder aliases(java.lang.String key, java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)Setaliases(Map)
to a singleton map. -
putAliases
public RolloverRequest.Builder putAliases(java.lang.String key, java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)Add a key/value toaliases(Map)
, creating the map if needed. -
conditions
API name:conditions
-
conditions
public RolloverRequest.Builder conditions(java.util.function.Function<RolloverConditions.Builder,ObjectBuilder<RolloverConditions>> fn)API name:conditions
-
mappings
API name:mappings
-
settings
API name:settings
-
putSettings
Add a key/value tosettings(Map)
, creating the map if needed. -
build
Builds aRolloverRequest
.- Specified by:
build
in interfaceObjectBuilder<RolloverRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-