deleteuser

Documentation

Overview

Deletes users from the native realm.

Index

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

Deletes 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(ctx context.Context) (*Response, error)

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

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

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

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

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

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

func (*DeleteUser) Username

func (r *DeleteUser) Username(username string) *DeleteUser

Username username API Name: username

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response