Class ClearCacheRequest

Request for ClearCache

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

Inheritance

object

RequestBase<ClearCacheRequestParameters>

PlainRequestBase<ClearCacheRequestParameters>

ClearCacheRequest

Implements

IClearCacheRequest

IRequest<ClearCacheRequestParameters>

IRequest

Inherited Members

PlainRequestBase<ClearCacheRequestParameters>.RequestConfiguration

PlainRequestBase<ClearCacheRequestParameters>.ErrorTrace

PlainRequestBase<ClearCacheRequestParameters>.FilterPath

PlainRequestBase<ClearCacheRequestParameters>.Human

PlainRequestBase<ClearCacheRequestParameters>.Pretty

PlainRequestBase<ClearCacheRequestParameters>.SourceQueryString

RequestBase<ClearCacheRequestParameters>.HttpMethod

RequestBase<ClearCacheRequestParameters>.RequestState

RequestBase<ClearCacheRequestParameters>.ContentType

RequestBase<ClearCacheRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)

RequestBase<ClearCacheRequestParameters>.RequestDefaults(ClearCacheRequestParameters)

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

RequestBase<ClearCacheRequestParameters>.Q(string, object)

RequestBase<ClearCacheRequestParameters>.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 ClearCacheRequest : PlainRequestBase<ClearCacheRequestParameters>, IClearCacheRequest, IRequest<ClearCacheRequestParameters>, IRequest

Constructors

ClearCacheRequest()

/_cache/clear

Declaration

public ClearCacheRequest()

ClearCacheRequest(Indices)

/{index}/_cache/clear

Declaration

public ClearCacheRequest(Indices index)

Parameters

Type	Name	Description
Indices	index	Optional, accepts null

Properties

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?

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?

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?

Fields

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

Declaration

public Fields Fields { get; set; }

Property Value

Type	Description
Fields

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.

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?

Query

If true, clears the query cache.

Declaration

public bool? Query { get; set; }

Property Value

Type	Description
bool?

Request

If true, clears the request cache.

Declaration

public bool? Request { get; set; }

Property Value

Type	Description
bool?

Self

Declaration

protected IClearCacheRequest Self { get; }

Property Value

Type	Description
IClearCacheRequest

Implements

IClearCacheRequest

IRequest<TParameters>

IRequest

Extension Methods

SuffixExtensions.Suffix(object, string)