Documentation
¶
Overview ¶
Retrieves information about all follower indices, including parameters and status for each follower index
Index ¶
- Variables
- type 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
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
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 ¶
HttpRequest returns the http.Request object built from the given parameters.
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 ¶ added in v8.7.0
type Response struct {
FollowerIndices []types.FollowerIndex `json:"follower_indices"`
}
Response holds the response body struct for the package followinfo
Source Files