clearapikeycache

Documentation

Overview

Clear a subset or all entries from the API key cache.

Index

• Variables
• type ClearApiKeyCache
  • func New(tp elastictransport.Interface) *ClearApiKeyCache
  • func (r ClearApiKeyCache) Do(ctx context.Context) (*http.Response, error)
  • func (r *ClearApiKeyCache) Header(key, value string) *ClearApiKeyCache
  • func (r *ClearApiKeyCache) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ClearApiKeyCache) Ids(v string) *ClearApiKeyCache
  • func (r ClearApiKeyCache) IsSuccess(ctx context.Context) (bool, error)
• type NewClearApiKeyCache
  • func NewClearApiKeyCacheFunc(tp elastictransport.Interface) NewClearApiKeyCache

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 a subset or all entries from the API key cache.

https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-api-key-cache.html

func (ClearApiKeyCache) Do

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

Do runs the http.Request through the provided transport.

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) Ids

func (r *ClearApiKeyCache) Ids(v string) *ClearApiKeyCache

Ids A comma-separated list of IDs of API keys to clear from the cache API Name: ids

func (ClearApiKeyCache) IsSuccess

func (r ClearApiKeyCache) IsSuccess(ctx 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.

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.