createcrossclusterapikey

Documentation

Overview

Creates a cross-cluster API key for API key based remote cluster access.

Index

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

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 CreateCrossClusterApiKey

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

func New

func New(tp elastictransport.Interface) *CreateCrossClusterApiKey

Creates a cross-cluster API key for API key based remote cluster access.

https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-cross-cluster-api-key.html

func (CreateCrossClusterApiKey) Do

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

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

func (*CreateCrossClusterApiKey) Header

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

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

func (*CreateCrossClusterApiKey) HttpRequest

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

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

func (CreateCrossClusterApiKey) IsSuccess

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

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

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

type NewCreateCrossClusterApiKey

type NewCreateCrossClusterApiKey func() *CreateCrossClusterApiKey

NewCreateCrossClusterApiKey type alias for index.

func NewCreateCrossClusterApiKeyFunc

func NewCreateCrossClusterApiKeyFunc(tp elastictransport.Interface) NewCreateCrossClusterApiKey

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