clearcachedrealms

Documentation

Overview

Clear the user cache.

Evict users from the user cache. You can completely clear the cache or evict specific users.

User credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request. There are realm settings that you can use to configure the user cache. For more information, refer to the documentation about controlling the user cache.

Index

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

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

func New

func New(tp elastictransport.Interface) *ClearCachedRealms

Clear the user cache.

Evict users from the user cache. You can completely clear the cache or evict specific users.

User credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request. There are realm settings that you can use to configure the user cache. For more information, refer to the documentation about controlling the user cache.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-clear-cached-realms

func (ClearCachedRealms) Do

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

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

func (*ClearCachedRealms) ErrorTrace

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

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

func (*ClearCachedRealms) FilterPath

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

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

func (*ClearCachedRealms) Header

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

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

func (*ClearCachedRealms) HttpRequest

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

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

func (*ClearCachedRealms) Human

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

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"exists_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 (ClearCachedRealms) IsSuccess

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

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

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

func (*ClearCachedRealms) Pretty

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

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

func (*ClearCachedRealms) Usernames

func (r *ClearCachedRealms) Usernames(usernames ...string) *ClearCachedRealms

Usernames A comma-separated list of the users to clear from the cache. If you do not specify this parameter, the API evicts all users from the user cache. API name: usernames

type NewClearCachedRealms

type NewClearCachedRealms func(realms string) *ClearCachedRealms

NewClearCachedRealms type alias for index.

func NewClearCachedRealmsFunc

func NewClearCachedRealmsFunc(tp elastictransport.Interface) NewClearCachedRealms

NewClearCachedRealmsFunc returns a new instance of ClearCachedRealms 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 clearcachedrealms

https://github.com/elastic/elasticsearch-specification/blob/907d11a72a6bfd37b777d526880c56202889609e/specification/security/clear_cached_realms/SecurityClearCachedRealmsResponse.ts#L25-L32

func NewResponse

func NewResponse() *Response

NewResponse returns a Response