getbuiltinprivileges

Documentation

Overview

Get builtin privileges.

Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch.

Index

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

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

func New

func New(tp elastictransport.Interface) *GetBuiltinPrivileges

Get builtin privileges.

Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch.

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

func (GetBuiltinPrivileges) Do

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

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

func (*GetBuiltinPrivileges) ErrorTrace

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

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

func (*GetBuiltinPrivileges) FilterPath

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

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

func (*GetBuiltinPrivileges) Header

func (r *GetBuiltinPrivileges) Header(key, value string) *GetBuiltinPrivileges

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

func (*GetBuiltinPrivileges) HttpRequest

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

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

func (*GetBuiltinPrivileges) Human

func (r *GetBuiltinPrivileges) Human(human bool) *GetBuiltinPrivileges

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 (GetBuiltinPrivileges) IsSuccess

func (r GetBuiltinPrivileges) 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 (GetBuiltinPrivileges) Perform

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

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

func (*GetBuiltinPrivileges) Pretty

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

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

type NewGetBuiltinPrivileges

type NewGetBuiltinPrivileges func() *GetBuiltinPrivileges

NewGetBuiltinPrivileges type alias for index.

func NewGetBuiltinPrivilegesFunc

func NewGetBuiltinPrivilegesFunc(tp elastictransport.Interface) NewGetBuiltinPrivileges

NewGetBuiltinPrivilegesFunc returns a new instance of GetBuiltinPrivileges with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Response

type Response struct {

	// Cluster The list of cluster privileges that are understood by this version of
	// Elasticsearch.
	Cluster []clusterprivilege.ClusterPrivilege `json:"cluster"`
	// Index The list of index privileges that are understood by this version of
	// Elasticsearch.
	Index []string `json:"index"`
	// RemoteCluster The list of remote_cluster privileges that are understood by this version of
	// Elasticsearch.
	RemoteCluster []remoteclusterprivilege.RemoteClusterPrivilege `json:"remote_cluster"`
}

Response holds the response body struct for the package getbuiltinprivileges

https://github.com/elastic/elasticsearch-specification/blob/470b4b9aaaa25cae633ec690e54b725c6fc939c7/specification/security/get_builtin_privileges/SecurityGetBuiltinPrivilegesResponse.ts#L26-L42

func NewResponse

func NewResponse() *Response

NewResponse returns a Response