disableuser

Documentation

Overview

Disable users.

Disable users in the native realm.

Index

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

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

func New

func New(tp elastictransport.Interface) *DisableUser

Disable users.

Disable users in the native realm.

https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html

func (DisableUser) Do

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

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

func (*DisableUser) ErrorTrace

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

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

func (*DisableUser) FilterPath

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

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

func (*DisableUser) Header

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

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

func (*DisableUser) HttpRequest

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

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

func (*DisableUser) Human

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

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

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

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

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

func (*DisableUser) Pretty

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

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

func (*DisableUser) Refresh

func (r *DisableUser) Refresh(refresh refresh.Refresh) *DisableUser

Refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. API name: refresh

type NewDisableUser

type NewDisableUser func(username string) *DisableUser

NewDisableUser type alias for index.

func NewDisableUserFunc

func NewDisableUserFunc(tp elastictransport.Interface) NewDisableUser

NewDisableUserFunc returns a new instance of DisableUser 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 {
}

Response holds the response body struct for the package disableuser

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/security/disable_user/SecurityDisableUserResponse.ts#L20-L22

func NewResponse

func NewResponse() *Response

NewResponse returns a Response