Package org.opensearch.client.opensearch.indices

Class ForcemergeRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.ForcemergeRequest

public class ForcemergeRequest
extends RequestBase

Performs the force merge operation on one or more indices.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<ForcemergeRequest,ForcemergeResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.forcemerge".

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	flush()	Specify whether the index should be flushed after performing the operation (default: true)
java.lang.Boolean	ignoreUnavailable()	Whether specified concrete indices should be ignored when unavailable (missing or closed)
java.util.List<java.lang.String>	index()	A comma-separated list of index names; use _all or empty string to perform the operation on all indices
java.lang.Long	maxNumSegments()	The number of segments the index should be merged into (default: dynamic)
static ForcemergeRequest	of(java.util.function.Function<ForcemergeRequest.Builder,ObjectBuilder<ForcemergeRequest>> fn)
java.lang.Boolean	onlyExpungeDeletes()	Specify whether the operation should only expunge deleted documents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_ENDPOINT

public static final Endpoint<ForcemergeRequest,ForcemergeResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.forcemerge".

Method Detail

of

public static ForcemergeRequest of(java.util.function.Function<ForcemergeRequest.Builder,ObjectBuilder<ForcemergeRequest>> 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

public final java.util.List<ExpandWildcard> expandWildcards()

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

API name: expand_wildcards

flush

@Nullable
public final java.lang.Boolean flush()

Specify whether the index should be flushed after performing the operation (default: true)

API name: flush

ignoreUnavailable

@Nullable
public final java.lang.Boolean ignoreUnavailable()

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

API name: ignore_unavailable

index

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

A comma-separated list of index names; use _all or empty string to perform the operation on all indices

API name: index

maxNumSegments

@Nullable
public final java.lang.Long maxNumSegments()

The number of segments the index should be merged into (default: dynamic)

API name: max_num_segments

onlyExpungeDeletes

@Nullable
public final java.lang.Boolean onlyExpungeDeletes()

Specify whether the operation should only expunge deleted documents

API name: only_expunge_deletes