Documentation ¶
Overview ¶
Retrieves application privileges.
Index ¶
- Variables
- type GetPrivileges
- func (r *GetPrivileges) Application(application string) *GetPrivileges
- func (r GetPrivileges) Do(ctx context.Context) (Response, error)
- func (r *GetPrivileges) Header(key, value string) *GetPrivileges
- func (r *GetPrivileges) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r GetPrivileges) IsSuccess(ctx context.Context) (bool, error)
- func (r *GetPrivileges) Name(name string) *GetPrivileges
- func (r GetPrivileges) Perform(ctx context.Context) (*http.Response, error)
- type NewGetPrivileges
- 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 GetPrivileges ¶
type GetPrivileges struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetPrivileges
Retrieves application privileges.
https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html
func (*GetPrivileges) Application ¶
func (r *GetPrivileges) Application(application string) *GetPrivileges
Application Application name API Name: application
func (GetPrivileges) Do ¶
func (r GetPrivileges) Do(ctx context.Context) (Response, error)
Do runs the request through the transport, handle the response and returns a getprivileges.Response
func (*GetPrivileges) Header ¶
func (r *GetPrivileges) Header(key, value string) *GetPrivileges
Header set a key, value pair in the GetPrivileges headers map.
func (*GetPrivileges) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (GetPrivileges) IsSuccess ¶
func (r GetPrivileges) IsSuccess(ctx 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 (*GetPrivileges) Name ¶
func (r *GetPrivileges) Name(name string) *GetPrivileges
Name Privilege name API Name: name
type NewGetPrivileges ¶
type NewGetPrivileges func() *GetPrivileges
NewGetPrivileges type alias for index.
func NewGetPrivilegesFunc ¶
func NewGetPrivilegesFunc(tp elastictransport.Interface) NewGetPrivileges
NewGetPrivilegesFunc returns a new instance of GetPrivileges with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.