Documentation ¶
Overview ¶
Evicts roles from the native role cache.
Index ¶
- Variables
- type ClearCachedRoles
- func (r ClearCachedRoles) Do(ctx context.Context) (*Response, error)
- func (r *ClearCachedRoles) Header(key, value string) *ClearCachedRoles
- func (r *ClearCachedRoles) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r ClearCachedRoles) IsSuccess(ctx context.Context) (bool, error)
- func (r *ClearCachedRoles) Name(name string) *ClearCachedRoles
- func (r ClearCachedRoles) Perform(ctx context.Context) (*http.Response, error)
- type NewClearCachedRoles
- 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 ClearCachedRoles ¶
type ClearCachedRoles struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *ClearCachedRoles
Evicts 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(ctx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a clearcachedroles.Response
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 ¶
HttpRequest returns the http.Request object built from the given parameters.
func (ClearCachedRoles) IsSuccess ¶
func (r ClearCachedRoles) IsSuccess(ctx 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) Name ¶
func (r *ClearCachedRoles) Name(name string) *ClearCachedRoles
Name Role name API Name: name
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 ¶ 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"` }