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) Header(key, value string) *FollowInfo
  • func (r *FollowInfo) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r FollowInfo) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r FollowInfo) Perform(providedCtx context.Context) (*http.Response, error)
• 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) 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) 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.

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/b2c13a00c152a97cb41193deda8ed9b37fd06796/specification/ccr/follow_info/FollowInfoResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response