Class ForceMergeDescriptor

Descriptor for ForceMerge

https://opensearch.org/docs/latest

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

Constructors

| Edit this page View Source

ForceMergeDescriptor()

/_forcemerge

Declaration
public ForceMergeDescriptor()
| Edit this page View Source

ForceMergeDescriptor(Indices)

/{index}/_forcemerge

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

Optional, accepts null

Methods

| Edit this page View Source

AllIndices()

A shortcut into calling Index(Indices.All)

Declaration
public ForceMergeDescriptor AllIndices()
Returns
Type Description
ForceMergeDescriptor
| Edit this page View Source

AllowNoIndices(bool?)

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

Declaration
public ForceMergeDescriptor AllowNoIndices(bool? allownoindices = true)
Parameters
Type Name Description
bool? allownoindices
Returns
Type Description
ForceMergeDescriptor
| Edit this page View Source

ExpandWildcards(ExpandWildcards?)

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

Declaration
public ForceMergeDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Type Name Description
ExpandWildcards? expandwildcards
Returns
Type Description
ForceMergeDescriptor
| Edit this page View Source

Flush(bool?)

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

Declaration
public ForceMergeDescriptor Flush(bool? flush = true)
Parameters
Type Name Description
bool? flush
Returns
Type Description
ForceMergeDescriptor
| Edit this page View Source

IgnoreUnavailable(bool?)

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

Declaration
public ForceMergeDescriptor IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type Name Description
bool? ignoreunavailable
Returns
Type Description
ForceMergeDescriptor
| Edit this page View Source

Index(Indices)

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

Declaration
public ForceMergeDescriptor Index(Indices index)
Parameters
Type Name Description
Indices index
Returns
Type Description
ForceMergeDescriptor
| Edit this page View Source

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration
public ForceMergeDescriptor Index<TOther>() where TOther : class
Returns
Type Description
ForceMergeDescriptor
Type Parameters
Name Description
TOther
| Edit this page View Source

MaxNumSegments(long?)

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 ForceMergeDescriptor MaxNumSegments(long? maxnumsegments)
Parameters
Type Name Description
long? maxnumsegments
Returns
Type Description
ForceMergeDescriptor
| Edit this page View Source

OnlyExpungeDeletes(bool?)

Specify whether the operation should only expunge deleted documents.

Declaration
public ForceMergeDescriptor OnlyExpungeDeletes(bool? onlyexpungedeletes = true)
Parameters
Type Name Description
bool? onlyexpungedeletes
Returns
Type Description
ForceMergeDescriptor
| Edit this page View Source

PrimaryOnly(bool?)

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

Declaration
public ForceMergeDescriptor PrimaryOnly(bool? primaryonly = true)
Parameters
Type Name Description
bool? primaryonly
Returns
Type Description
ForceMergeDescriptor
Remarks

Supported by OpenSearch servers of version 2.13.0 or greater.

| Edit this page View Source

WaitForCompletion(bool?)

Should the request wait until the force merge is completed.

Declaration
public ForceMergeDescriptor WaitForCompletion(bool? waitforcompletion = true)
Parameters
Type Name Description
bool? waitforcompletion
Returns
Type Description
ForceMergeDescriptor
Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

Implements

Extension Methods