getrolemapping

Documentation

Overview

Retrieves role mappings.

Index

• Variables
• type GetRoleMapping
  • func New(tp elastictransport.Interface) *GetRoleMapping
  • func (r GetRoleMapping) Do(ctx context.Context) (Response, error)
  • func (r *GetRoleMapping) Header(key, value string) *GetRoleMapping
  • func (r *GetRoleMapping) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r GetRoleMapping) IsSuccess(ctx context.Context) (bool, error)
  • func (r *GetRoleMapping) Name(v string) *GetRoleMapping
  • func (r GetRoleMapping) Perform(ctx context.Context) (*http.Response, error)
• type NewGetRoleMapping
  • func NewGetRoleMappingFunc(tp elastictransport.Interface) NewGetRoleMapping
• 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 GetRoleMapping

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

func New

func New(tp elastictransport.Interface) *GetRoleMapping

Retrieves role mappings.

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

func (GetRoleMapping) Do

func (r GetRoleMapping) Do(ctx context.Context) (Response, error)

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

func (*GetRoleMapping) Header

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

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

func (*GetRoleMapping) HttpRequest

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

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

func (GetRoleMapping) IsSuccess

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

func (r *GetRoleMapping) Name(v string) *GetRoleMapping

Name The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way. You can specify multiple mapping names as a comma-separated list. If you do not specify this parameter, the API returns information about all role mappings. API Name: name

func (GetRoleMapping) Perform

func (r GetRoleMapping) Perform(ctx context.Context) (*http.Response, error)

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

type NewGetRoleMapping

type NewGetRoleMapping func() *GetRoleMapping

NewGetRoleMapping type alias for index.

func NewGetRoleMappingFunc

func NewGetRoleMappingFunc(tp elastictransport.Interface) NewGetRoleMapping

NewGetRoleMappingFunc returns a new instance of GetRoleMapping 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]types.SecurityRoleMapping

func NewResponse

func NewResponse() Response

NewResponse returns a Response