clearcache

Documentation

Overview

Clears the caches of one or more indices. For data streams, the API clears the caches of the stream’s backing indices.

Index

• Variables
• type ClearCache
  • func New(tp elastictransport.Interface) *ClearCache
  • func (r *ClearCache) AllowNoIndices(allownoindices bool) *ClearCache
  • func (r ClearCache) Do(providedCtx context.Context) (*Response, error)
  • func (r *ClearCache) ErrorTrace(errortrace bool) *ClearCache
  • func (r *ClearCache) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *ClearCache
  • func (r *ClearCache) Fielddata(fielddata bool) *ClearCache
  • func (r *ClearCache) Fields(fields ...string) *ClearCache
  • func (r *ClearCache) FilterPath(filterpaths ...string) *ClearCache
  • func (r *ClearCache) Header(key, value string) *ClearCache
  • func (r *ClearCache) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ClearCache) Human(human bool) *ClearCache
  • func (r *ClearCache) IgnoreUnavailable(ignoreunavailable bool) *ClearCache
  • func (r *ClearCache) Index(index string) *ClearCache
  • func (r ClearCache) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r ClearCache) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *ClearCache) Pretty(pretty bool) *ClearCache
  • func (r *ClearCache) Query(query bool) *ClearCache
  • func (r *ClearCache) Request(request bool) *ClearCache
• type NewClearCache
  • func NewClearCacheFunc(tp elastictransport.Interface) NewClearCache
• type Response
  • func NewResponse() *Response

Variables

var ErrBuildPath = errors.New("cannot build path, check for missing path parameters")

ErrBuildPath is returned in case of missing parameters within the build of the request.

Types

type ClearCache

type ClearCache struct {
	// contains filtered or unexported fields
}

func New

func New(tp elastictransport.Interface) *ClearCache

Clears the caches of one or more indices. For data streams, the API clears the caches of the stream’s backing indices.

https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-clearcache.html

func (*ClearCache) AllowNoIndices

func (r *ClearCache) AllowNoIndices(allownoindices bool) *ClearCache

AllowNoIndices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. API name: allow_no_indices

func (ClearCache) Do

func (r ClearCache) Do(providedCtx context.Context) (*Response, error)

Do runs the request through the transport, handle the response and returns a clearcache.Response

func (*ClearCache) ErrorTrace

func (r *ClearCache) ErrorTrace(errortrace bool) *ClearCache

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*ClearCache) ExpandWildcards

func (r *ClearCache) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *ClearCache

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`. API name: expand_wildcards

func (*ClearCache) Fielddata

func (r *ClearCache) Fielddata(fielddata bool) *ClearCache

Fielddata If `true`, clears the fields cache. Use the `fields` parameter to clear the cache of specific fields only. API name: fielddata

func (*ClearCache) Fields

func (r *ClearCache) Fields(fields ...string) *ClearCache

Fields Comma-separated list of field names used to limit the `fielddata` parameter. API name: fields

func (*ClearCache) FilterPath

func (r *ClearCache) FilterPath(filterpaths ...string) *ClearCache

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*ClearCache) Header

func (r *ClearCache) Header(key, value string) *ClearCache

Header set a key, value pair in the ClearCache headers map.

func (*ClearCache) HttpRequest

func (r *ClearCache) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (*ClearCache) Human

func (r *ClearCache) Human(human bool) *ClearCache

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (*ClearCache) IgnoreUnavailable

func (r *ClearCache) IgnoreUnavailable(ignoreunavailable bool) *ClearCache

IgnoreUnavailable If `false`, the request returns an error if it targets a missing or closed index. API name: ignore_unavailable

func (*ClearCache) Index

func (r *ClearCache) Index(index string) *ClearCache

Index Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. API Name: index

func (ClearCache) IsSuccess

func (r ClearCache) IsSuccess(providedCtx context.Context) (bool, error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.

func (ClearCache) Perform

func (r ClearCache) Perform(providedCtx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*ClearCache) Pretty

func (r *ClearCache) Pretty(pretty bool) *ClearCache

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

func (*ClearCache) Query

func (r *ClearCache) Query(query bool) *ClearCache

Query If `true`, clears the query cache. API name: query

func (*ClearCache) Request

func (r *ClearCache) Request(request bool) *ClearCache

Request If `true`, clears the request cache. API name: request

type NewClearCache

type NewClearCache func() *ClearCache

NewClearCache type alias for index.

func NewClearCacheFunc

func NewClearCacheFunc(tp elastictransport.Interface) NewClearCache

NewClearCacheFunc returns a new instance of ClearCache with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Response

type Response struct {
	Shards_ *types.ShardStatistics `json:"_shards,omitempty"`
}

Response holds the response body struct for the package clearcache

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/indices/clear_cache/IndicesClearCacheResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response