Documentation
¶
Overview ¶
Retrieves roles in the native realm.
Index ¶
- Variables
- type GetRole
- func (r GetRole) Do(providedCtx context.Context) (Response, error)
- func (r *GetRole) Header(key, value string) *GetRole
- func (r *GetRole) HttpRequest(ctx context.Context) (*http.Request, error)
- 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)
- 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
Retrieves roles in the native realm.
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html
func (GetRole) Do ¶
Do runs the request through the transport, handle the response and returns a getrole.Response
func (*GetRole) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
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.
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