clearcachedservicetokens

Documentation

Overview

Evicts tokens from the service account token caches.

Index

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

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

func New

func New(tp elastictransport.Interface) *ClearCachedServiceTokens

Evicts tokens from the service account token caches.

https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-service-token-caches.html

func (ClearCachedServiceTokens) Do

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

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

func (*ClearCachedServiceTokens) ErrorTrace

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

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

func (*ClearCachedServiceTokens) FilterPath

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

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

func (*ClearCachedServiceTokens) Header

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

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

func (*ClearCachedServiceTokens) HttpRequest

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

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

func (*ClearCachedServiceTokens) Human

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

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

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

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

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

func (*ClearCachedServiceTokens) Pretty

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

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

type NewClearCachedServiceTokens

type NewClearCachedServiceTokens func(namespace, service, name string) *ClearCachedServiceTokens

NewClearCachedServiceTokens type alias for index.

func NewClearCachedServiceTokensFunc

func NewClearCachedServiceTokensFunc(tp elastictransport.Interface) NewClearCachedServiceTokens

NewClearCachedServiceTokensFunc returns a new instance of ClearCachedServiceTokens 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 clearcachedservicetokens

https://github.com/elastic/elasticsearch-specification/blob/19027dbdd366978ccae41842a040a636730e7c10/specification/security/clear_cached_service_tokens/ClearCachedServiceTokensResponse.ts#L25-L32

func NewResponse

func NewResponse() *Response

NewResponse returns a Response