Class FreezeRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<FreezeRequest.Builder>
co.elastic.clients.elasticsearch.indices.FreezeRequest.Builder
- All Implemented Interfaces:
WithJson<FreezeRequest.Builder>
,ObjectBuilder<FreezeRequest>
- Enclosing class:
- FreezeRequest
public static class FreezeRequest.Builder
extends RequestBase.AbstractBuilder<FreezeRequest.Builder>
implements ObjectBuilder<FreezeRequest>
Builder for
FreezeRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal FreezeRequest.Builder
allowNoIndices
(Boolean value) Whether to ignore if a wildcard indices expression resolves into no concrete indices.build()
Builds aFreezeRequest
.final FreezeRequest.Builder
expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Whether to expand wildcard expression to concrete indices that are open, closed or both.final FreezeRequest.Builder
expandWildcards
(List<ExpandWildcard> list) Whether to expand wildcard expression to concrete indices that are open, closed or both.final FreezeRequest.Builder
ignoreUnavailable
(Boolean value) Whether specified concrete indices should be ignored when unavailable (missing or closed)final FreezeRequest.Builder
Required - The name of the index to freezefinal FreezeRequest.Builder
masterTimeout
(Time value) Specify timeout for connection to masterfinal FreezeRequest.Builder
Specify timeout for connection to masterprotected FreezeRequest.Builder
self()
final FreezeRequest.Builder
Explicit operation timeoutfinal FreezeRequest.Builder
Explicit operation timeoutfinal FreezeRequest.Builder
Sets the number of active shards to wait for before the operation returns.final FreezeRequest.Builder
Sets the number of active shards to wait for before the operation returns.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
-
allowNoIndices
Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes_all
string or when no indices have been specified)API name:
allow_no_indices
-
expandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
Adds one or more values to
expandWildcards
. -
index
Required - The name of the index to freezeAPI name:
index
-
masterTimeout
Specify timeout for connection to masterAPI name:
master_timeout
-
masterTimeout
Specify timeout for connection to masterAPI name:
master_timeout
-
timeout
Explicit operation timeoutAPI name:
timeout
-
timeout
Explicit operation timeoutAPI name:
timeout
-
waitForActiveShards
Sets the number of active shards to wait for before the operation returns.API name:
wait_for_active_shards
-
waitForActiveShards
public final FreezeRequest.Builder waitForActiveShards(Function<WaitForActiveShards.Builder, ObjectBuilder<WaitForActiveShards>> fn) Sets the number of active shards to wait for before the operation returns.API name:
wait_for_active_shards
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<FreezeRequest.Builder>
-
build
Builds aFreezeRequest
.- Specified by:
build
in interfaceObjectBuilder<FreezeRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-