Class AddBlockRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.AddBlockRequest
public class AddBlockRequest extends RequestBase
Adds a block to an index.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AddBlockRequest.Builder
Builder forAddBlockRequest
.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<AddBlockRequest,AddBlockResponse,ErrorResponse>
_ENDPOINT
Endpoint "indices.add_block
". -
Method Summary
Modifier and Type Method Description java.lang.Boolean
allowNoIndices()
Whether to ignore if a wildcard indices expression resolves into no concrete indices.IndicesBlockOptions
block()
Required - The block to add (one of read, write, read_only or metadata)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 - A comma separated list of indices to add a block toTime
masterTimeout()
Specify timeout for connection to masterstatic AddBlockRequest
of(java.util.function.Function<AddBlockRequest.Builder,ObjectBuilder<AddBlockRequest>> fn)
Time
timeout()
Explicit operation timeoutMethods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_ENDPOINT
Endpoint "indices.add_block
".
-
-
Method Details
-
of
public static AddBlockRequest of(java.util.function.Function<AddBlockRequest.Builder,ObjectBuilder<AddBlockRequest>> 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
-
block
Required - The block to add (one of read, write, read_only or metadata)API name:
block
-
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 - A comma separated list of indices to add a block toAPI name:
index
-
masterTimeout
Specify timeout for connection to masterAPI name:
master_timeout
-
timeout
Explicit operation timeoutAPI name:
timeout
-