Documentation ¶
Overview ¶
Pauses a follower index. The follower index will not fetch any additional operations from the leader index.
Index ¶
- Variables
- type NewPauseFollow
- type PauseFollow
- func (r PauseFollow) Do(ctx context.Context) (*http.Response, error)
- func (r *PauseFollow) Header(key, value string) *PauseFollow
- func (r *PauseFollow) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *PauseFollow) Index(v string) *PauseFollow
- func (r PauseFollow) IsSuccess(ctx context.Context) (bool, error)
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 NewPauseFollow ¶
type NewPauseFollow func(index string) *PauseFollow
NewPauseFollow type alias for index.
func NewPauseFollowFunc ¶
func NewPauseFollowFunc(tp elastictransport.Interface) NewPauseFollow
NewPauseFollowFunc returns a new instance of PauseFollow with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type PauseFollow ¶
type PauseFollow struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *PauseFollow
Pauses a follower index. The follower index will not fetch any additional operations from the leader index.
https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-post-pause-follow.html
func (*PauseFollow) Header ¶
func (r *PauseFollow) Header(key, value string) *PauseFollow
Header set a key, value pair in the PauseFollow headers map.
func (*PauseFollow) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*PauseFollow) Index ¶
func (r *PauseFollow) Index(v string) *PauseFollow
Index The name of the follower index that should pause following its leader index. API Name: index