clearcachedroles

Documentation

Overview

Clear the roles cache.

Evict roles from the native role cache.

Index

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

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

func New

func New(tp elastictransport.Interface) *ClearCachedRoles

Clear the roles cache.

Evict roles from the native role cache.

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

func (ClearCachedRoles) Do

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

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

func (*ClearCachedRoles) ErrorTrace

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

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

func (*ClearCachedRoles) FilterPath

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

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

func (*ClearCachedRoles) Header

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

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

func (*ClearCachedRoles) HttpRequest

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

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

func (*ClearCachedRoles) Human

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

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

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

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

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

func (*ClearCachedRoles) Pretty

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

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

type NewClearCachedRoles

type NewClearCachedRoles func(name string) *ClearCachedRoles

NewClearCachedRoles type alias for index.

func NewClearCachedRolesFunc

func NewClearCachedRolesFunc(tp elastictransport.Interface) NewClearCachedRoles

NewClearCachedRolesFunc returns a new instance of ClearCachedRoles 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 clearcachedroles

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/security/clear_cached_roles/ClearCachedRolesResponse.ts#L25-L32

func NewResponse

func NewResponse() *Response

NewResponse returns a Response