bulkupdateapikeys

Documentation

Overview

Updates the attributes of multiple existing API keys.

Index

• Variables
• type BulkUpdateApiKeys
  • func New(tp elastictransport.Interface) *BulkUpdateApiKeys
  • func (r BulkUpdateApiKeys) Do(ctx context.Context) (bool, error)
  • func (r *BulkUpdateApiKeys) Header(key, value string) *BulkUpdateApiKeys
  • func (r *BulkUpdateApiKeys) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r BulkUpdateApiKeys) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r BulkUpdateApiKeys) Perform(providedCtx context.Context) (*http.Response, error)
• type NewBulkUpdateApiKeys
  • func NewBulkUpdateApiKeysFunc(tp elastictransport.Interface) NewBulkUpdateApiKeys

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 BulkUpdateApiKeys

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

func New

func New(tp elastictransport.Interface) *BulkUpdateApiKeys

Updates the attributes of multiple existing API keys.

https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-update-api-keys.html

func (BulkUpdateApiKeys) Do

func (r BulkUpdateApiKeys) Do(ctx context.Context) (bool, error)

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

func (*BulkUpdateApiKeys) Header

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

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

func (*BulkUpdateApiKeys) HttpRequest

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

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

func (BulkUpdateApiKeys) IsSuccess

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

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

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

type NewBulkUpdateApiKeys

type NewBulkUpdateApiKeys func() *BulkUpdateApiKeys

NewBulkUpdateApiKeys type alias for index.

func NewBulkUpdateApiKeysFunc

func NewBulkUpdateApiKeysFunc(tp elastictransport.Interface) NewBulkUpdateApiKeys

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