Package org.opensearch.client.opensearch.indices

Class ForcemergeRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<ForcemergeRequest.Builder>

org.opensearch.client.opensearch.indices.ForcemergeRequest.Builder

All Implemented Interfaces:

CopyableBuilder<ForcemergeRequest.Builder,ForcemergeRequest>, MutableBuilder<ForcemergeRequest.Builder,ForcemergeRequest>, ObjectBuilder<ForcemergeRequest>

Enclosing class:

ForcemergeRequest

public static class ForcemergeRequest.Builder
extends RequestBase.AbstractBuilder<ForcemergeRequest.Builder>
implements CopyableBuilder<ForcemergeRequest.Builder,ForcemergeRequest>

Builder for ForcemergeRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final ForcemergeRequest.Builder	allowNoIndices(Boolean value)	Whether to ignore if a wildcard indexes expression resolves into no concrete indexes.
ForcemergeRequest	build()	Builds a ForcemergeRequest.
ForcemergeRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ForcemergeRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indexes that are open, closed or both.
final ForcemergeRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indexes that are open, closed or both.
final ForcemergeRequest.Builder	flush(Boolean value)	Specify whether the index should be flushed after performing the operation.
final ForcemergeRequest.Builder	ignoreUnavailable(Boolean value)	Whether specified concrete indexes should be ignored when unavailable (missing or closed)
final ForcemergeRequest.Builder	index(String value, String... values)	A comma-separated list of index names; use _all or empty string to perform the operation on all indexes
final ForcemergeRequest.Builder	index(List<String> list)	A comma-separated list of index names; use _all or empty string to perform the operation on all indexes
final ForcemergeRequest.Builder	maxNumSegments(Long value)	The number of larger segments into which smaller segments are merged.
final ForcemergeRequest.Builder	onlyExpungeDeletes(Boolean value)	Specify whether the operation should only expunge deleted documents
final ForcemergeRequest.Builder	primaryOnly(Boolean value)	Specify whether the operation should only perform on primary shards.
protected ForcemergeRequest.Builder	self()
final ForcemergeRequest.Builder	waitForCompletion(Boolean value)	Should the request wait until the force merge is completed.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public ForcemergeRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<ForcemergeRequest.Builder,ForcemergeRequest>

Returns:

a new builder instance.

self

@Nonnull
protected ForcemergeRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ForcemergeRequest.Builder>

allowNoIndices

@Nonnull
public final ForcemergeRequest.Builder allowNoIndices(@Nullable
 Boolean value)

Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes _all string or when no indexes have been specified)

API name: allow_no_indices

expandWildcards

@Nonnull
public final ForcemergeRequest.Builder expandWildcards(List<ExpandWildcard> list)

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

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

@Nonnull
public final ForcemergeRequest.Builder expandWildcards(ExpandWildcard value,
 ExpandWildcard... values)

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

API name: expand_wildcards

Adds one or more values to expandWildcards.

flush

@Nonnull
public final ForcemergeRequest.Builder flush(@Nullable
 Boolean value)

Specify whether the index should be flushed after performing the operation.

API name: flush

ignoreUnavailable

@Nonnull
public final ForcemergeRequest.Builder ignoreUnavailable(@Nullable
 Boolean value)

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

API name: ignore_unavailable

index

@Nonnull
public final ForcemergeRequest.Builder index(List<String> list)

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

API name: index

Adds all elements of list to index.

index

@Nonnull
public final ForcemergeRequest.Builder index(String value,
 String... values)

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

API name: index

Adds one or more values to index.

maxNumSegments

@Nonnull
public final ForcemergeRequest.Builder maxNumSegments(@Nullable
 Long value)

The number of larger segments into which smaller segments are merged. Set this parameter to 1 to merge all segments into one segment. The default behavior is to perform the merge as necessary.

API name: max_num_segments

onlyExpungeDeletes

@Nonnull
public final ForcemergeRequest.Builder onlyExpungeDeletes(@Nullable
 Boolean value)

Specify whether the operation should only expunge deleted documents

API name: only_expunge_deletes

primaryOnly

@Nonnull
public final ForcemergeRequest.Builder primaryOnly(@Nullable
 Boolean value)

Specify whether the operation should only perform on primary shards. Defaults to false.

API name: primary_only

waitForCompletion

@Nonnull
public final ForcemergeRequest.Builder waitForCompletion(@Nullable
 Boolean value)

Should the request wait until the force merge is completed.

API name: wait_for_completion

build

@Nonnull
public ForcemergeRequest build()

Builds a ForcemergeRequest.

Specified by:

build in interface ObjectBuilder<ForcemergeRequest>

Throws:

NullPointerException - if some of the required fields are null.