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

funcNew¶

func New(tpelastictransport.Interface) *DeleteUser

Delete users.

Delete users from the native realm.

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

func (DeleteUser)Do¶

func (rDeleteUser) Do(providedCtxcontext.Context) (*Response,error)

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

func (*DeleteUser)ErrorTrace¶added inv8.14.0

func (r *DeleteUser) ErrorTrace(errortracebool) *DeleteUser

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

func (*DeleteUser)FilterPath¶added inv8.14.0

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

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

func (*DeleteUser)Header¶

func (r *DeleteUser) Header(key, valuestring) *DeleteUser

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

func (*DeleteUser)HttpRequest¶

func (r *DeleteUser) HttpRequest(ctxcontext.Context) (*http.Request,error)

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

func (*DeleteUser)Human¶added inv8.14.0

func (r *DeleteUser) Human(humanbool) *DeleteUser

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 humanreadable values will be omitted. This makes sense for responses beingconsumedonly by machines.API name: human

func (DeleteUser)IsSuccess¶

func (rDeleteUser) IsSuccess(providedCtxcontext.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 (DeleteUser)Perform¶added inv8.7.0

func (rDeleteUser) Perform(providedCtxcontext.Context) (*http.Response,error)

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

func (*DeleteUser)Pretty¶added inv8.14.0

func (r *DeleteUser) Pretty(prettybool) *DeleteUser

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

func (*DeleteUser)Refresh¶

func (r *DeleteUser) Refresh(refreshrefresh.Refresh) *DeleteUser

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

type NewDeleteUser func(usernamestring) *DeleteUser

funcNewDeleteUserFunc¶

func NewDeleteUserFunc(tpelastictransport.Interface)NewDeleteUser

NewDeleteUserFunc returns a new instance of DeleteUser with the provided transport.Used in the index of the library this allows to retrieve every apis in once place.

type Response struct {// Found If the user is successfully deleted, the request returns `{"found": true}`.// Otherwise, `found` is set to `false`.Foundbool `json:"found"`}

funcNewResponse¶added inv8.7.0

func NewResponse() *Response

NewResponse returns a Response