Search Results for

    Show / Hide Table of Contents

    Class ClearCacheRequestParameters

    Request options for ClearCache

    https://opensearch.org/docs/latest/api-reference/index-apis/clear-index-cache/

    Inheritance
    object
    RequestParameters<ClearCacheRequestParameters>
    ClearCacheRequestParameters
    Implements
    IRequestParameters
    Inherited Members
    RequestParameters<ClearCacheRequestParameters>.CustomResponseBuilder
    RequestParameters<ClearCacheRequestParameters>.QueryString
    RequestParameters<ClearCacheRequestParameters>.RequestConfiguration
    RequestParameters<ClearCacheRequestParameters>.ContainsQueryString(string)
    RequestParameters<ClearCacheRequestParameters>.GetQueryStringValue<TOut>(string)
    RequestParameters<ClearCacheRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)
    RequestParameters<ClearCacheRequestParameters>.SetQueryString(string, object)
    RequestParameters<ClearCacheRequestParameters>.Q<TOut>(string)
    RequestParameters<ClearCacheRequestParameters>.Q(string, object)
    RequestParameters<ClearCacheRequestParameters>.SetAcceptHeader(string)
    RequestParameters<ClearCacheRequestParameters>.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 ClearCacheRequestParameters : RequestParameters<ClearCacheRequestParameters>, IRequestParameters

    Properties

    | Edit this page View Source

    AllowNoIndices

    If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes.

    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<ClearCacheRequestParameters>.DefaultHttpMethod
    | Edit this page View Source

    ExpandWildcards

    Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.

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

    Fielddata

    If true, clears the fields cache. Use the fields parameter to clear the cache of specific fields only.

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

    Fields

    Comma-separated list of field names used to limit the fielddata parameter.

    Declaration
    public string[] Fields { get; set; }
    Property Value
    Type Description
    string[]
    | Edit this page View Source

    File

    If true, clears the unused entries from the file cache on nodes with the Search role.

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

    Supported by OpenSearch servers of version 2.8.0 or greater.

    | Edit this page View Source

    IgnoreUnavailable

    If false, the request returns an error if it targets a missing or closed index.

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

    Index

    Comma-separated list of indexes; use _all or empty string to perform the operation on all indexes.

    Declaration
    public string[] Index { get; set; }
    Property Value
    Type Description
    string[]
    | Edit this page View Source

    Query

    If true, clears the query cache.

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

    Request

    If true, clears the request cache.

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

    SupportsBody

    Declaration
    public override bool SupportsBody { get; }
    Property Value
    Type Description
    bool
    Overrides
    RequestParameters<ClearCacheRequestParameters>.SupportsBody

    Implements

    IRequestParameters

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • AllowNoIndices
      • DefaultHttpMethod
      • ExpandWildcards
      • Fielddata
      • Fields
      • File
      • IgnoreUnavailable
      • Index
      • Query
      • Request
      • SupportsBody
    • Implements
    • Extension Methods
    Back to top Generated by DocFX