clearcachedprivileges

Documentation

Overview

Evicts application privileges from the native application privileges cache.

Index

• Variables
• type ClearCachedPrivileges
  • func New(tp elastictransport.Interface) *ClearCachedPrivileges
  • func (r *ClearCachedPrivileges) Application(v string) *ClearCachedPrivileges
  • func (r ClearCachedPrivileges) Do(ctx context.Context) (*Response, error)
  • func (r *ClearCachedPrivileges) Header(key, value string) *ClearCachedPrivileges
  • func (r *ClearCachedPrivileges) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r ClearCachedPrivileges) IsSuccess(ctx context.Context) (bool, error)
  • func (r ClearCachedPrivileges) Perform(ctx context.Context) (*http.Response, error)
• 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

Evicts application privileges from the native application privileges cache.

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

func (*ClearCachedPrivileges) Application

func (r *ClearCachedPrivileges) Application(v string) *ClearCachedPrivileges

Application A comma-separated list of application names API Name: application

func (ClearCachedPrivileges) Do

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

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

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

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

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

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

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"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response