clearcachedprivileges

Documentation

Overview

Clear the privileges cache.

Evict privileges from the native application privilege cache. The cache is also automatically cleared for applications that have their privileges updated.

Index

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

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

func New

func New(tp elastictransport.Interface) *ClearCachedPrivileges

Clear the privileges cache.

Evict privileges from the native application privilege cache. The cache is also automatically cleared for applications that have their privileges updated.

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

func (ClearCachedPrivileges) Do

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

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

func (*ClearCachedPrivileges) ErrorTrace

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

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

func (*ClearCachedPrivileges) FilterPath

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

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

func (*ClearCachedPrivileges) Header

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

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

func (*ClearCachedPrivileges) HttpRequest

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

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

func (*ClearCachedPrivileges) Human

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

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

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

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

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

func (*ClearCachedPrivileges) Pretty

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

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

type NewClearCachedPrivileges

type NewClearCachedPrivileges func(application string) *ClearCachedPrivileges

NewClearCachedPrivileges type alias for index.

func NewClearCachedPrivilegesFunc

func NewClearCachedPrivilegesFunc(tp elastictransport.Interface) NewClearCachedPrivileges

NewClearCachedPrivilegesFunc returns a new instance of ClearCachedPrivileges 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 clearcachedprivileges

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response