Class FreezeRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.FreezeRequest
public class FreezeRequest extends RequestBase
Freezes an index. A frozen index has almost no overhead on the cluster
(except for maintaining its metadata in memory) and is read-only.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FreezeRequest.Builder
Builder forFreezeRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static Endpoint<FreezeRequest,FreezeResponse,ErrorResponse>
_ENDPOINT
Endpoint "indices.freeze
". -
Method Summary
Modifier and Type Method Description java.lang.Boolean
allowNoIndices()
Whether to ignore if a wildcard indices expression resolves into no concrete indices.java.util.List<ExpandWildcard>
expandWildcards()
Whether to expand wildcard expression to concrete indices that are open, closed or both.java.lang.Boolean
ignoreUnavailable()
Whether specified concrete indices should be ignored when unavailable (missing or closed)java.lang.String
index()
Required - The name of the index to freezeTime
masterTimeout()
Specify timeout for connection to masterstatic FreezeRequest
of(java.util.function.Function<FreezeRequest.Builder,ObjectBuilder<FreezeRequest>> fn)
Time
timeout()
Explicit operation timeoutWaitForActiveShards
waitForActiveShards()
Sets the number of active shards to wait for before the operation returns.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_ENDPOINT
Endpoint "indices.freeze
".
-
-
Method Details
-
of
public static FreezeRequest of(java.util.function.Function<FreezeRequest.Builder,ObjectBuilder<FreezeRequest>> fn) -
allowNoIndices
@Nullable public final java.lang.Boolean 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
-
index
public final java.lang.String index()Required - The name of the index to freezeAPI name:
index
-
masterTimeout
Specify timeout for connection to masterAPI name:
master_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
-