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 (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
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
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/docs/api/doc/elasticsearch/operation/operation-security-get-role
func (GetRole) Do ¶
Do runs the request through the transport, handle the response and returns a getrole.Response
func (*GetRole) ErrorTrace ¶
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*GetRole) FilterPath ¶
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*GetRole) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*GetRole) Human ¶
Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"exists_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 ¶
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 ¶
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
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.
Source Files