putrolemapping

Documentation

Overview

Creates and updates role mappings.

Index

• Variables
• type NewPutRoleMapping
  • func NewPutRoleMappingFunc(tp elastictransport.Interface) NewPutRoleMapping
• type PutRoleMapping
  • func New(tp elastictransport.Interface) *PutRoleMapping
  • func (r PutRoleMapping) Do(ctx context.Context) (*Response, error)
  • func (r *PutRoleMapping) Enabled(enabled bool) *PutRoleMapping
  • func (r *PutRoleMapping) Header(key, value string) *PutRoleMapping
  • func (r *PutRoleMapping) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutRoleMapping) Metadata(metadata types.Metadata) *PutRoleMapping
  • func (r *PutRoleMapping) Name(name string) *PutRoleMapping
  • func (r PutRoleMapping) Perform(ctx context.Context) (*http.Response, error)
  • func (r *PutRoleMapping) Raw(raw io.Reader) *PutRoleMapping
  • func (r *PutRoleMapping) Refresh(refresh refresh.Refresh) *PutRoleMapping
  • func (r *PutRoleMapping) Request(req *Request) *PutRoleMapping
  • func (r *PutRoleMapping) Roles(roles ...string) *PutRoleMapping
  • func (r *PutRoleMapping) Rules(rules *types.RoleMappingRule) *PutRoleMapping
  • func (r *PutRoleMapping) RunAs(runas ...string) *PutRoleMapping
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• 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 NewPutRoleMapping

type NewPutRoleMapping func(name string) *PutRoleMapping

NewPutRoleMapping type alias for index.

func NewPutRoleMappingFunc

func NewPutRoleMappingFunc(tp elastictransport.Interface) NewPutRoleMapping

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

type PutRoleMapping

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

func New

func New(tp elastictransport.Interface) *PutRoleMapping

Creates and updates role mappings.

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

func (PutRoleMapping) Do

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

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

func (*PutRoleMapping) Enabled

func (r *PutRoleMapping) Enabled(enabled bool) *PutRoleMapping

API name: enabled

func (*PutRoleMapping) Header

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

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

func (*PutRoleMapping) HttpRequest

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

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

func (*PutRoleMapping) Metadata

func (r *PutRoleMapping) Metadata(metadata types.Metadata) *PutRoleMapping

API name: metadata

func (*PutRoleMapping) Name

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

Name Role-mapping name API Name: name

func (PutRoleMapping) Perform

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

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

func (*PutRoleMapping) Raw

func (r *PutRoleMapping) Raw(raw io.Reader) *PutRoleMapping

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

func (*PutRoleMapping) Refresh

func (r *PutRoleMapping) Refresh(refresh refresh.Refresh) *PutRoleMapping

Refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. API name: refresh

func (*PutRoleMapping) Request

func (r *PutRoleMapping) Request(req *Request) *PutRoleMapping

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

func (*PutRoleMapping) Roles

func (r *PutRoleMapping) Roles(roles ...string) *PutRoleMapping

API name: roles

func (*PutRoleMapping) Rules

func (r *PutRoleMapping) Rules(rules *types.RoleMappingRule) *PutRoleMapping

API name: rules

func (*PutRoleMapping) RunAs

func (r *PutRoleMapping) RunAs(runas ...string) *PutRoleMapping

API name: run_as

type Request

type Request struct {
	Enabled  *bool                  `json:"enabled,omitempty"`
	Metadata types.Metadata         `json:"metadata,omitempty"`
	Roles    []string               `json:"roles,omitempty"`
	Rules    *types.RoleMappingRule `json:"rules,omitempty"`
	RunAs    []string               `json:"run_as,omitempty"`
}

Request holds the request body struct for the package putrolemapping

https://github.com/elastic/elasticsearch-specification/blob/656080dee792f93a849cd7fbf566f528f858a5ea/specification/security/put_role_mapping/SecurityPutRoleMappingRequest.ts#L24-L43

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

type Response

type Response struct {
	Created     *bool               `json:"created,omitempty"`
	RoleMapping types.CreatedStatus `json:"role_mapping"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response