getrole

Documentation

Overview

Get roles.

Get roles in the native realm. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The get roles API cannot retrieve roles that are defined in roles files.

Index

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

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

func New

func New(tp elastictransport.Interface) *GetRole

Get roles.

Get roles in the native realm. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The get roles API cannot retrieve roles that are defined in roles files.

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

func (GetRole) Do

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

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

func (*GetRole) ErrorTrace

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

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

func (*GetRole) FilterPath

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

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

func (*GetRole) Header

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

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

func (*GetRole) HttpRequest

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

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

func (*GetRole) Human

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

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

func (r GetRole) 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 (*GetRole) Name

func (r *GetRole) Name(name string) *GetRole

Name The name of the role. You can specify multiple roles as a comma-separated list. If you do not specify this parameter, the API returns information about all roles. API Name: name

func (GetRole) Perform

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

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

func (*GetRole) Pretty

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

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

type NewGetRole

type NewGetRole func() *GetRole

NewGetRole type alias for index.

func NewGetRoleFunc

func NewGetRoleFunc(tp elastictransport.Interface) NewGetRole

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

type Response

type Response map[string]types.Role

func NewResponse

func NewResponse() Response

NewResponse returns a Response