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
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ClearCacheRequest : PlainRequestBase<ClearCacheRequestParameters>, IClearCacheRequest, IRequest<ClearCacheRequestParameters>, IRequest

Constructors

| Edit this page View Source

ClearCacheRequest()

/_cache/clear

Declaration
public ClearCacheRequest()
| Edit this page View Source

ClearCacheRequest(Indices)

/{index}/_cache/clear

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

Optional, accepts null

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

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 Fields Fields { get; set; }
Property Value
Type Description
Fields
| 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

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

Self

Declaration
protected IClearCacheRequest Self { get; }
Property Value
Type Description
IClearCacheRequest

Implements

Extension Methods