hasprivileges

Documentation

Overview

Determines whether the specified user has a specified list of privileges.

Index

• Variables
• type HasPrivileges
  • func New(tp elastictransport.Interface) *HasPrivileges
  • func (r HasPrivileges) Do(ctx context.Context) (*http.Response, error)
  • func (r *HasPrivileges) Header(key, value string) *HasPrivileges
  • func (r *HasPrivileges) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *HasPrivileges) Raw(raw json.RawMessage) *HasPrivileges
  • func (r *HasPrivileges) Request(req *Request) *HasPrivileges
  • func (r *HasPrivileges) User(v string) *HasPrivileges
• type NewHasPrivileges
  • func NewHasPrivilegesFunc(tp elastictransport.Interface) NewHasPrivileges
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Application(application []types.ApplicationPrivilegesCheckBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) Cluster(cluster ...clusterprivilege.ClusterPrivilege) *RequestBuilder
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) Index(index []types.IndexPrivilegesCheckBuilder) *RequestBuilder

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 HasPrivileges

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

func New

func New(tp elastictransport.Interface) *HasPrivileges

Determines whether the specified user has a specified list of privileges.

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

func (HasPrivileges) Do

func (r HasPrivileges) Do(ctx context.Context) (*http.Response, error)

Do runs the http.Request through the provided transport.

func (*HasPrivileges) Header

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

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

func (*HasPrivileges) HttpRequest

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

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

func (*HasPrivileges) Raw

func (r *HasPrivileges) Raw(raw json.RawMessage) *HasPrivileges

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*HasPrivileges) Request

func (r *HasPrivileges) Request(req *Request) *HasPrivileges

Request allows to set the request property with the appropriate payload.

func (*HasPrivileges) User

func (r *HasPrivileges) User(v string) *HasPrivileges

User Username API Name: user

type NewHasPrivileges

type NewHasPrivileges func() *HasPrivileges

NewHasPrivileges type alias for index.

func NewHasPrivilegesFunc

func NewHasPrivilegesFunc(tp elastictransport.Interface) NewHasPrivileges

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

type Request

type Request struct {
	Application []types.ApplicationPrivilegesCheck `json:"application,omitempty"`

	// Cluster A list of the cluster privileges that you want to check.
	Cluster []clusterprivilege.ClusterPrivilege `json:"cluster,omitempty"`

	Index []types.IndexPrivilegesCheck `json:"index,omitempty"`
}

Request holds the request body struct for the package hasprivileges

https://github.com/elastic/elasticsearch-specification/blob/1b56d7e58f5c59f05d1641c6d6a8117c5e01d741/specification/security/has_privileges/SecurityHasPrivilegesRequest.ts#L25-L42

type RequestBuilder

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

RequestBuilder is the builder API for the hasprivileges.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Application

func (rb *RequestBuilder) Application(application []types.ApplicationPrivilegesCheckBuilder) *RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) Cluster

func (rb *RequestBuilder) Cluster(cluster ...clusterprivilege.ClusterPrivilege) *RequestBuilder

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) Index

func (rb *RequestBuilder) Index(index []types.IndexPrivilegesCheckBuilder) *RequestBuilder