master

Documentation

Overview

Returns information about the master node.

Index

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

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

func New

func New(tp elastictransport.Interface) *Master

Returns information about the master node.

https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-master.html

func (Master) Do

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

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

func (*Master) Header

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

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

func (*Master) HttpRequest

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

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

func (Master) IsSuccess

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

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

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

type NewMaster

type NewMaster func() *Master

NewMaster type alias for index.

func NewMasterFunc

func NewMasterFunc(tp elastictransport.Interface) NewMaster

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

type Response

type Response []types.MasterRecord

func NewResponse

func NewResponse() Response

NewResponse returns a Response