Package co.elastic.clients.elasticsearch.indices

Class CloseIndexRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.CloseIndexRequest

All Implemented Interfaces:

ElasticsearchCommonRequest

public final class CloseIndexRequest
extends RequestBase

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CloseIndexRequest.Builder	Builder for CloseIndexRequest.

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<CloseIndexRequest,CloseIndexResponse,ElasticsearchError>	ENDPOINT	Endpoint "indices.close".

Constructor Summary

Constructors

Constructor	Description
CloseIndexRequest(CloseIndexRequest.Builder builder)
CloseIndexRequest(java.util.function.Function<CloseIndexRequest.Builder,CloseIndexRequest.Builder> fn)

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<ExpandWildcardOptions>	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.util.List<java.lang.String>	index()	Required - A comma separated list of indices to close
java.lang.String	masterTimeout()	Specify timeout for connection to master
java.lang.String	timeout()	Explicit operation timeout
jakarta.json.JsonValue	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

public static final Endpoint<CloseIndexRequest,CloseIndexResponse,ElasticsearchError> ENDPOINT

Endpoint "indices.close".

Constructor Details

CloseIndexRequest

public CloseIndexRequest(CloseIndexRequest.Builder builder)

CloseIndexRequest

public CloseIndexRequest(java.util.function.Function<CloseIndexRequest.Builder,CloseIndexRequest.Builder> fn)

Method Details

index

public java.util.List<java.lang.String> index()

Required - A comma separated list of indices to close

API name: index

allowNoIndices

@Nullable
public 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

@Nullable
public java.util.List<ExpandWildcardOptions> expandWildcards()

Whether to expand wildcard expression to concrete indices that are open, closed or both.

API name: expand_wildcards

ignoreUnavailable

@Nullable
public java.lang.Boolean ignoreUnavailable()

Whether specified concrete indices should be ignored when unavailable (missing or closed)

API name: ignore_unavailable

masterTimeout

@Nullable
public java.lang.String masterTimeout()

Specify timeout for connection to master

API name: master_timeout

timeout

@Nullable
public java.lang.String timeout()

Explicit operation timeout

API name: timeout

waitForActiveShards

@Nullable
public jakarta.json.JsonValue waitForActiveShards()

Sets the number of active shards to wait for before the operation returns. Set to index-setting to wait according to the index setting index.write.wait_for_active_shards, or all to wait for all shards, or an integer. Defaults to 0.

API name: wait_for_active_shards