Search Results for

    Show / Hide Table of Contents

    Class ForceMergeRequestParameters

    Request options for ForceMerge

    https://opensearch.org/docs/latest

    Inheritance
    object
    RequestParameters<ForceMergeRequestParameters>
    ForceMergeRequestParameters
    Implements
    IRequestParameters
    Inherited Members
    RequestParameters<ForceMergeRequestParameters>.CustomResponseBuilder
    RequestParameters<ForceMergeRequestParameters>.QueryString
    RequestParameters<ForceMergeRequestParameters>.RequestConfiguration
    RequestParameters<ForceMergeRequestParameters>.ContainsQueryString(string)
    RequestParameters<ForceMergeRequestParameters>.GetQueryStringValue<TOut>(string)
    RequestParameters<ForceMergeRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)
    RequestParameters<ForceMergeRequestParameters>.SetQueryString(string, object)
    RequestParameters<ForceMergeRequestParameters>.Q<TOut>(string)
    RequestParameters<ForceMergeRequestParameters>.Q(string, object)
    RequestParameters<ForceMergeRequestParameters>.SetAcceptHeader(string)
    RequestParameters<ForceMergeRequestParameters>.AcceptHeaderFromFormat(string)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Net.Specification.IndicesApi
    Assembly: OpenSearch.Net.dll
    Syntax
    public class ForceMergeRequestParameters : RequestParameters<ForceMergeRequestParameters>, IRequestParameters

    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

    DefaultHttpMethod

    Declaration
    public override HttpMethod DefaultHttpMethod { get; }
    Property Value
    Type Description
    HttpMethod
    Overrides
    RequestParameters<ForceMergeRequestParameters>.DefaultHttpMethod
    | 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

    SupportsBody

    Declaration
    public override bool SupportsBody { get; }
    Property Value
    Type Description
    bool
    Overrides
    RequestParameters<ForceMergeRequestParameters>.SupportsBody
    | 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

    IRequestParameters

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • AllowNoIndices
      • DefaultHttpMethod
      • ExpandWildcards
      • Flush
      • IgnoreUnavailable
      • MaxNumSegments
      • OnlyExpungeDeletes
      • PrimaryOnly
      • SupportsBody
      • WaitForCompletion
    • Implements
    • Extension Methods
    Back to top Generated by DocFX