deleterolemapping

Documentation

Overview

Delete role mappings.

Index

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

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

func New

func New(tp elastictransport.Interface) *DeleteRoleMapping

Delete role mappings.

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

func (DeleteRoleMapping) Do

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

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

func (*DeleteRoleMapping) ErrorTrace

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

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

func (*DeleteRoleMapping) FilterPath

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

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

func (*DeleteRoleMapping) Header

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

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

func (*DeleteRoleMapping) HttpRequest

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

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

func (*DeleteRoleMapping) Human

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

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

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

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

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

func (*DeleteRoleMapping) Pretty

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

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

func (*DeleteRoleMapping) Refresh

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

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 NewDeleteRoleMapping

type NewDeleteRoleMapping func(name string) *DeleteRoleMapping

NewDeleteRoleMapping type alias for index.

func NewDeleteRoleMappingFunc

func NewDeleteRoleMappingFunc(tp elastictransport.Interface) NewDeleteRoleMapping

NewDeleteRoleMappingFunc returns a new instance of DeleteRoleMapping 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 deleterolemapping

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response