clearcachedprivileges

package
v8.17.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 17, 2024 License: Apache-2.0 Imports: 11 Imported by: 4

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

Constants

This section is empty.

Variables

View Source
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.

Functions

This section is empty.

Types

type ClearCachedPrivileges

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

func New

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/guide/en/elasticsearch/reference/current/security-api-clear-privilege-cache.html

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 added in v8.14.0

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 added in v8.14.0

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 added in v8.14.0

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 added in v8.7.0

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 added in v8.14.0

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 added in v8.7.0

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/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/security/clear_cached_privileges/SecurityClearCachedPrivilegesResponse.ts#L25-L32

func NewResponse added in v8.7.0

func NewResponse() *Response

NewResponse returns a Response

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL