followstats

Documentation

Overview

Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices.

Index

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

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

func New

func New(tp elastictransport.Interface) *FollowStats

Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices.

https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-get-follow-stats.html

func (FollowStats) Do

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

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

func (*FollowStats) Header

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

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

func (*FollowStats) HttpRequest

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

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

func (FollowStats) IsSuccess

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

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

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

type NewFollowStats

type NewFollowStats func(index string) *FollowStats

NewFollowStats type alias for index.

func NewFollowStatsFunc

func NewFollowStatsFunc(tp elastictransport.Interface) NewFollowStats

NewFollowStatsFunc returns a new instance of FollowStats 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 {
	Indices []types.FollowIndexStats `json:"indices"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response