Documentation
¶
Overview ¶
Evicts users from the user cache. Can completely clear the cache or evict specific users.
Index ¶
- Variables
- type ClearCachedRealms
- func (r ClearCachedRealms) Do(providedCtx context.Context) (*Response, error)
- func (r *ClearCachedRealms) Header(key, value string) *ClearCachedRealms
- func (r *ClearCachedRealms) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r ClearCachedRealms) IsSuccess(providedCtx context.Context) (bool, error)
- func (r ClearCachedRealms) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *ClearCachedRealms) Usernames(usernames ...string) *ClearCachedRealms
- type NewClearCachedRealms
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
Types ¶
type ClearCachedRealms ¶
type ClearCachedRealms struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *ClearCachedRealms
Evicts users from the user cache. Can completely clear the cache or evict specific users.
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html
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) Header ¶
func (r *ClearCachedRealms) Header(key, value string) *ClearCachedRealms
Header set a key, value pair in the ClearCachedRealms headers map.
func (*ClearCachedRealms) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
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 ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*ClearCachedRealms) Usernames ¶
func (r *ClearCachedRealms) Usernames(usernames ...string) *ClearCachedRealms
Usernames Comma-separated list of usernames to clear from the 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 ¶ 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 clearcachedrealms
Source Files