Class ClearCacheDescriptor

Descriptor for ClearCache

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

Inheritance
object
RequestBase<ClearCacheRequestParameters>
RequestDescriptorBase<ClearCacheDescriptor, ClearCacheRequestParameters, IClearCacheRequest>
ClearCacheDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ClearCacheDescriptor : RequestDescriptorBase<ClearCacheDescriptor, ClearCacheRequestParameters, IClearCacheRequest>, IDescriptor, IClearCacheRequest, IRequest<ClearCacheRequestParameters>, IRequest

Constructors

| Edit this page View Source

ClearCacheDescriptor()

/_cache/clear

Declaration
public ClearCacheDescriptor()
| Edit this page View Source

ClearCacheDescriptor(Indices)

/{index}/_cache/clear

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

Optional, accepts null

Methods

| Edit this page View Source

AllIndices()

A shortcut into calling Index(Indices.All)

Declaration
public ClearCacheDescriptor AllIndices()
Returns
Type Description
ClearCacheDescriptor
| Edit this page View Source

AllowNoIndices(bool?)

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 ClearCacheDescriptor AllowNoIndices(bool? allownoindices = true)
Parameters
Type Name Description
bool? allownoindices
Returns
Type Description
ClearCacheDescriptor
| Edit this page View Source

ExpandWildcards(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 ClearCacheDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Type Name Description
ExpandWildcards? expandwildcards
Returns
Type Description
ClearCacheDescriptor
| Edit this page View Source

Fielddata(bool?)

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

Declaration
public ClearCacheDescriptor Fielddata(bool? fielddata = true)
Parameters
Type Name Description
bool? fielddata
Returns
Type Description
ClearCacheDescriptor
| Edit this page View Source

Fields(Fields)

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

Declaration
public ClearCacheDescriptor Fields(Fields fields)
Parameters
Type Name Description
Fields fields
Returns
Type Description
ClearCacheDescriptor
| Edit this page View Source

Fields<T>(params Expression<Func<T, object>>[])

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

Declaration
public ClearCacheDescriptor Fields<T>(params Expression<Func<T, object>>[] fields) where T : class
Parameters
Type Name Description
Expression<Func<T, object>>[] fields
Returns
Type Description
ClearCacheDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

File(bool?)

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

Declaration
public ClearCacheDescriptor File(bool? file = true)
Parameters
Type Name Description
bool? file
Returns
Type Description
ClearCacheDescriptor
Remarks

Supported by OpenSearch servers of version 2.8.0 or greater.

| Edit this page View Source

IgnoreUnavailable(bool?)

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

Declaration
public ClearCacheDescriptor IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
Type Name Description
bool? ignoreunavailable
Returns
Type Description
ClearCacheDescriptor
| Edit this page View Source

Index(Indices)

Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

Declaration
public ClearCacheDescriptor Index(Indices index)
Parameters
Type Name Description
Indices index
Returns
Type Description
ClearCacheDescriptor
| Edit this page View Source

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration
public ClearCacheDescriptor Index<TOther>() where TOther : class
Returns
Type Description
ClearCacheDescriptor
Type Parameters
Name Description
TOther
| Edit this page View Source

Query(bool?)

If true, clears the query cache.

Declaration
public ClearCacheDescriptor Query(bool? query = true)
Parameters
Type Name Description
bool? query
Returns
Type Description
ClearCacheDescriptor
| Edit this page View Source

Request(bool?)

If true, clears the request cache.

Declaration
public ClearCacheDescriptor Request(bool? request = true)
Parameters
Type Name Description
bool? request
Returns
Type Description
ClearCacheDescriptor

Implements

Extension Methods