Class ForceMergeRequest

Request for ForceMerge

https://opensearch.org/docs/latest

Inheritance

object

RequestBase<ForceMergeRequestParameters>

PlainRequestBase<ForceMergeRequestParameters>

ForceMergeRequest

Implements

IForceMergeRequest

IRequest<ForceMergeRequestParameters>

IRequest

Inherited Members

PlainRequestBase<ForceMergeRequestParameters>.RequestConfiguration

PlainRequestBase<ForceMergeRequestParameters>.ErrorTrace

PlainRequestBase<ForceMergeRequestParameters>.FilterPath

PlainRequestBase<ForceMergeRequestParameters>.Human

PlainRequestBase<ForceMergeRequestParameters>.Pretty

PlainRequestBase<ForceMergeRequestParameters>.SourceQueryString

RequestBase<ForceMergeRequestParameters>.HttpMethod

RequestBase<ForceMergeRequestParameters>.RequestState

RequestBase<ForceMergeRequestParameters>.ContentType

RequestBase<ForceMergeRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)

RequestBase<ForceMergeRequestParameters>.RequestDefaults(ForceMergeRequestParameters)

RequestBase<ForceMergeRequestParameters>.Q<TOut>(string)

RequestBase<ForceMergeRequestParameters>.Q(string, object)

RequestBase<ForceMergeRequestParameters>.SetAcceptHeader(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public class ForceMergeRequest : PlainRequestBase<ForceMergeRequestParameters>, IForceMergeRequest, IRequest<ForceMergeRequestParameters>, IRequest

Constructors

ForceMergeRequest()

/_forcemerge

Declaration

public ForceMergeRequest()

ForceMergeRequest(Indices)

/{index}/_forcemerge

Declaration

public ForceMergeRequest(Indices index)

Parameters

Type	Name	Description
Indices	index	Optional, accepts null

Properties

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?

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?

Flush

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

Declaration

public bool? Flush { get; set; }

Property Value

Type	Description
bool?

IgnoreUnavailable

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

Declaration

public bool? IgnoreUnavailable { get; set; }

Property Value

Type	Description
bool?

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?

OnlyExpungeDeletes

Specify whether the operation should only expunge deleted documents.

Declaration

public bool? OnlyExpungeDeletes { get; set; }

Property Value

Type	Description
bool?

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.

Self

Declaration

protected IForceMergeRequest Self { get; }

Property Value

Type	Description
IForceMergeRequest

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

IForceMergeRequest

IRequest<TParameters>

IRequest

Extension Methods

SuffixExtensions.Suffix(object, string)