deleterole

Documentation

Overview

Removes roles in the native realm.

Index

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

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

func New

func New(tp elastictransport.Interface) *DeleteRole

Removes roles in the native realm.

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

func (DeleteRole) Do

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

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

func (*DeleteRole) Header

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

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

func (*DeleteRole) HttpRequest

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

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

func (DeleteRole) IsSuccess

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

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

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

func (*DeleteRole) Refresh

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

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 NewDeleteRole

type NewDeleteRole func(name string) *DeleteRole

NewDeleteRole type alias for index.

func NewDeleteRoleFunc

func NewDeleteRoleFunc(tp elastictransport.Interface) NewDeleteRole

NewDeleteRoleFunc returns a new instance of DeleteRole 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 deleterole

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/security/delete_role/SecurityDeleteRoleResponse.ts#L20-L22

func NewResponse

func NewResponse() *Response

NewResponse returns a Response