Class ForceMergeRequest

Request for ForceMerge

https://opensearch.org/docs/latest

Inheritance
object
RequestBase<ForceMergeRequestParameters>
PlainRequestBase<ForceMergeRequestParameters>
ForceMergeRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ForceMergeRequest : PlainRequestBase<ForceMergeRequestParameters>, IForceMergeRequest, IRequest<ForceMergeRequestParameters>, IRequest

Constructors

| Edit this page View Source

ForceMergeRequest()

/_forcemerge

Declaration
public ForceMergeRequest()
| Edit this page View Source

ForceMergeRequest(Indices)

/{index}/_forcemerge

Declaration
public ForceMergeRequest(Indices index)
Parameters
Type Name Description
Indices index

Optional, accepts null

Properties

| Edit this page View Source

AllowNoIndices

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

Declaration
public bool? AllowNoIndices { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

ExpandWildcards

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

Declaration
public ExpandWildcards? ExpandWildcards { get; set; }
Property Value
Type Description
ExpandWildcards?
| Edit this page View Source

Flush

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

Declaration
public bool? Flush { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

IgnoreUnavailable

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

Declaration
public bool? IgnoreUnavailable { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

MaxNumSegments

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.

Declaration
public long? MaxNumSegments { get; set; }
Property Value
Type Description
long?
| Edit this page View Source

OnlyExpungeDeletes

Specify whether the operation should only expunge deleted documents.

Declaration
public bool? OnlyExpungeDeletes { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

PrimaryOnly

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

Declaration
public bool? PrimaryOnly { get; set; }
Property Value
Type Description
bool?
Remarks

Supported by OpenSearch servers of version 2.13.0 or greater.

| Edit this page View Source

Self

Declaration
protected IForceMergeRequest Self { get; }
Property Value
Type Description
IForceMergeRequest
| Edit this page View Source

WaitForCompletion

Should the request wait until the force merge is completed.

Declaration
public bool? WaitForCompletion { get; set; }
Property Value
Type Description
bool?
Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

Implements

Extension Methods