getprivileges

Documentation

Overview

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 application being referenced in the request.

Index

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

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

func New

func New(tp elastictransport.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 application being 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(application string) *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 all privileges for all applications. API Name: application

func (GetPrivileges) Do

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

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

func (*GetPrivileges) ErrorTrace

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

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

func (*GetPrivileges) FilterPath

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

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

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

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

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

func (*GetPrivileges) Human

func (r *GetPrivileges) Human(human bool) *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 human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (GetPrivileges) IsSuccess

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

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

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

func (GetPrivileges) Perform

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

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

func (*GetPrivileges) Pretty

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

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

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.

type Response

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

func NewResponse

func NewResponse() Response

NewResponse returns a Response