clearapikeycache

Documentation

Overview

Clear the API key cache.

Evict a subset of all entries from the API key cache. The cache is also automatically cleared on state changes of the security index.

Index

• Variables
• type ClearApiKeyCache
  • func New(tp elastictransport.Interface) *ClearApiKeyCache
  • func (r ClearApiKeyCache) Do(providedCtx context.Context) (*Response, error)
  • func (r *ClearApiKeyCache) ErrorTrace(errortrace bool) *ClearApiKeyCache
  • func (r *ClearApiKeyCache) FilterPath(filterpaths ...string) *ClearApiKeyCache
  • func (r *ClearApiKeyCache) Header(key, value string) *ClearApiKeyCache
  • func (r *ClearApiKeyCache) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ClearApiKeyCache) Human(human bool) *ClearApiKeyCache
  • func (r ClearApiKeyCache) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r ClearApiKeyCache) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *ClearApiKeyCache) Pretty(pretty bool) *ClearApiKeyCache
• type NewClearApiKeyCache
  • func NewClearApiKeyCacheFunc(tp elastictransport.Interface) NewClearApiKeyCache
• 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 ClearApiKeyCache

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

func New

func New(tp elastictransport.Interface) *ClearApiKeyCache

Clear the API key cache.

Evict a subset of all entries from the API key cache. The cache is also automatically cleared on state changes of the security index.

https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-clear-api-key-cache

func (ClearApiKeyCache) Do

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

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

func (*ClearApiKeyCache) ErrorTrace

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

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

func (*ClearApiKeyCache) FilterPath

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

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

func (*ClearApiKeyCache) Header

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

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

func (*ClearApiKeyCache) HttpRequest

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

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

func (*ClearApiKeyCache) Human

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

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 (ClearApiKeyCache) IsSuccess

func (r ClearApiKeyCache) 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 (ClearApiKeyCache) Perform

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

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

func (*ClearApiKeyCache) Pretty

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

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

type NewClearApiKeyCache

type NewClearApiKeyCache func(ids string) *ClearApiKeyCache

NewClearApiKeyCache type alias for index.

func NewClearApiKeyCacheFunc

func NewClearApiKeyCacheFunc(tp elastictransport.Interface) NewClearApiKeyCache

NewClearApiKeyCacheFunc returns a new instance of ClearApiKeyCache 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 {
	ClusterName string                       `json:"cluster_name"`
	NodeStats   types.NodeStatistics         `json:"_nodes"`
	Nodes       map[string]types.ClusterNode `json:"nodes"`
}

Response holds the response body struct for the package clearapikeycache

https://github.com/elastic/elasticsearch-specification/blob/52c473efb1fb5320a5bac12572d0b285882862fb/specification/security/clear_api_key_cache/SecurityClearApiKeyCacheResponse.ts#L25-L32

func NewResponse

func NewResponse() *Response

NewResponse returns a Response