info

Documentation

Overview

Returns different information about the cluster.

Index

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

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

func New

func New(tp elastictransport.Interface) *Info

Returns different information about the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-info.html

func (Info) Do

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

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

func (*Info) Header

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

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

func (*Info) HttpRequest

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

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

func (Info) IsSuccess

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

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

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

type NewInfo

type NewInfo func(target string) *Info

NewInfo type alias for index.

func NewInfoFunc

func NewInfoFunc(tp elastictransport.Interface) NewInfo

NewInfoFunc returns a new instance of Info 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 {
	ClusterName string                       `json:"cluster_name"`
	Http        *types.Http                  `json:"http,omitempty"`
	Ingest      *types.NodesIngest           `json:"ingest,omitempty"`
	Script      *types.Scripting             `json:"script,omitempty"`
	ThreadPool  map[string]types.ThreadCount `json:"thread_pool,omitempty"`
}

Response holds the response body struct for the package info

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/cluster/info/ClusterInfoResponse.ts#L26-L34

func NewResponse

func NewResponse() *Response

NewResponse returns a Response