enrollkibana

Documentation

Overview

Enroll Kibana.

Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.

Index

• Variables
• type EnrollKibana
  • func New(tp elastictransport.Interface) *EnrollKibana
  • func (r EnrollKibana) Do(providedCtx context.Context) (*Response, error)
  • func (r *EnrollKibana) ErrorTrace(errortrace bool) *EnrollKibana
  • func (r *EnrollKibana) FilterPath(filterpaths ...string) *EnrollKibana
  • func (r *EnrollKibana) Header(key, value string) *EnrollKibana
  • func (r *EnrollKibana) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *EnrollKibana) Human(human bool) *EnrollKibana
  • func (r EnrollKibana) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r EnrollKibana) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *EnrollKibana) Pretty(pretty bool) *EnrollKibana
• 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

Enroll Kibana.

Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.

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

func (EnrollKibana) Do

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

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

func (*EnrollKibana) ErrorTrace

func (r *EnrollKibana) ErrorTrace(errortrace bool) *EnrollKibana

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*EnrollKibana) FilterPath

func (r *EnrollKibana) FilterPath(filterpaths ...string) *EnrollKibana

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

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) Human

func (r *EnrollKibana) Human(human bool) *EnrollKibana

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (EnrollKibana) IsSuccess

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

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

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

func (*EnrollKibana) Pretty

func (r *EnrollKibana) Pretty(pretty bool) *EnrollKibana

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

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"`
}

Response holds the response body struct for the package enrollkibana

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/security/enroll_kibana/Response.ts#L20-L25

func NewResponse

func NewResponse() *Response

NewResponse returns a Response