followinfo

Documentation

Overview

Retrieves information about all follower indices, including parameters and status for each follower index

Index

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

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

func New

func New(tp elastictransport.Interface) *FollowInfo

Retrieves information about all follower indices, including parameters and status for each follower index

https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html

func (FollowInfo) Do

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

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

func (*FollowInfo) ErrorTrace

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

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

func (*FollowInfo) FilterPath

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

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

func (*FollowInfo) Header

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

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

func (*FollowInfo) HttpRequest

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

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

func (*FollowInfo) Human

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

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 (FollowInfo) IsSuccess

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

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

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

func (*FollowInfo) Pretty

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

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

type NewFollowInfo

type NewFollowInfo func(index string) *FollowInfo

NewFollowInfo type alias for index.

func NewFollowInfoFunc

func NewFollowInfoFunc(tp elastictransport.Interface) NewFollowInfo

NewFollowInfoFunc returns a new instance of FollowInfo 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 {
	FollowerIndices []types.FollowerIndex `json:"follower_indices"`
}

Response holds the response body struct for the package followinfo

https://github.com/elastic/elasticsearch-specification/blob/07bf82537a186562d8699685e3704ea338b268ef/specification/ccr/follow_info/FollowInfoResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response