enrollkibana

Documentation

Overview

Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster.

Index

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

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

func New

func New(tp elastictransport.Interface) *EnrollKibana

Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-kibana-enrollment.html

func (EnrollKibana) Do

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

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

func (*EnrollKibana) Header

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

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

func (*EnrollKibana) HttpRequest

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

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

func (EnrollKibana) IsSuccess

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

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

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

type NewEnrollKibana

type NewEnrollKibana func() *EnrollKibana

NewEnrollKibana type alias for index.

func NewEnrollKibanaFunc

func NewEnrollKibanaFunc(tp elastictransport.Interface) NewEnrollKibana

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

type Response

type Response struct {
	HttpCa string            `json:"http_ca"`
	Token  types.KibanaToken `json:"token"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response