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

funcNew¶

func New(tpelastictransport.Interface) *GetPrivileges

Get application privileges.

To use this API, you must have one of the following privileges:

* The `read_security` cluster privilege (or a greater privilege such as`manage_security` or `all`).* The "Manage Application Privileges" global privilege for the applicationbeing referenced in the request.

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

func (*GetPrivileges)Application¶

func (r *GetPrivileges) Application(applicationstring) *GetPrivileges

Application The name of the application.Application privileges are always associated with exactly one application.If you do not specify this parameter, the API returns information about allprivileges for all applications.API Name: application

func (GetPrivileges)Do¶

func (rGetPrivileges) Do(providedCtxcontext.Context) (Response,error)

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

func (*GetPrivileges)ErrorTrace¶added inv8.14.0

func (r *GetPrivileges) ErrorTrace(errortracebool) *GetPrivileges

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

func (*GetPrivileges)FilterPath¶added inv8.14.0

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

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

func (*GetPrivileges)Header¶

func (r *GetPrivileges) Header(key, valuestring) *GetPrivileges

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

func (*GetPrivileges)HttpRequest¶

func (r *GetPrivileges) HttpRequest(ctxcontext.Context) (*http.Request,error)

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

func (*GetPrivileges)Human¶added inv8.14.0

func (r *GetPrivileges) Human(humanbool) *GetPrivileges

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 humanreadable values will be omitted. This makes sense for responses beingconsumedonly by machines.API name: human

func (GetPrivileges)IsSuccess¶

func (rGetPrivileges) IsSuccess(providedCtxcontext.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(namestring) *GetPrivileges

Name The name of the privilege.If you do not specify this parameter, the API returns information about allprivileges for the requested application.API Name: name

func (GetPrivileges)Perform¶added inv8.7.0

func (rGetPrivileges) Perform(providedCtxcontext.Context) (*http.Response,error)

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

func (*GetPrivileges)Pretty¶added inv8.14.0

func (r *GetPrivileges) Pretty(prettybool) *GetPrivileges

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

type NewGetPrivileges func() *GetPrivileges

funcNewGetPrivilegesFunc¶

func NewGetPrivilegesFunc(tpelastictransport.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.

type Response map[string]map[string]types.PrivilegesActions

funcNewResponse¶added inv8.7.0

func NewResponse()Response

NewResponse returns a Response