deleteuser

Documentation

Overview

Delete users.

Delete users from the native realm.

Index

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

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

func New

func New(tp elastictransport.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 (r DeleteUser) Do(providedCtx context.Context) (*Response, error)

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

func (*DeleteUser) ErrorTrace

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

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

func (*DeleteUser) FilterPath

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

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

func (*DeleteUser) Header

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

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

func (*DeleteUser) HttpRequest

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

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

func (*DeleteUser) Human

func (r *DeleteUser) Human(human bool) *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 human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (DeleteUser) IsSuccess

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

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

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

func (*DeleteUser) Pretty

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

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

func (*DeleteUser) Refresh

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

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 NewDeleteUser

type NewDeleteUser func(username string) *DeleteUser

NewDeleteUser type alias for index.

func NewDeleteUserFunc

func NewDeleteUserFunc(tp elastictransport.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

type Response struct {
	Found bool `json:"found"`
}

Response holds the response body struct for the package deleteuser

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/security/delete_user/SecurityDeleteUserResponse.ts#L20-L22

func NewResponse

func NewResponse() *Response

NewResponse returns a Response