The highest tagged major version is
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(providedCtx context.Context) (*Response, error)
- func (r *PauseFollow) ErrorTrace(errortrace bool) *PauseFollow
- func (r *PauseFollow) FilterPath(filterpaths ...string) *PauseFollow
- func (r *PauseFollow) Header(key, value string) *PauseFollow
- func (r *PauseFollow) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *PauseFollow) Human(human bool) *PauseFollow
- func (r PauseFollow) IsSuccess(providedCtx context.Context) (bool, error)
- func (r PauseFollow) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *PauseFollow) Pretty(pretty bool) *PauseFollow
- 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 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/current/ccr-post-pause-follow.html
func (PauseFollow) Do ¶
func (r PauseFollow) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a pausefollow.Response
func (*PauseFollow) ErrorTrace ¶ added in v8.14.0
func (r *PauseFollow) ErrorTrace(errortrace bool) *PauseFollow
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*PauseFollow) FilterPath ¶ added in v8.14.0
func (r *PauseFollow) FilterPath(filterpaths ...string) *PauseFollow
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
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) Human ¶ added in v8.14.0
func (r *PauseFollow) Human(human bool) *PauseFollow
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 (PauseFollow) IsSuccess ¶
func (r PauseFollow) 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 (PauseFollow) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*PauseFollow) Pretty ¶ added in v8.14.0
func (r *PauseFollow) Pretty(pretty bool) *PauseFollow
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
Source Files