pausefollow

Documentation

Overview

Pause a follower.

Pause a cross-cluster replication follower index. The follower index will not fetch any additional operations from the leader index. You can resume following with the resume follower API. You can pause and resume a follower index to change the configuration of the following task.

Index

• Variables
• type NewPauseFollow
  • func NewPauseFollowFunc(tp elastictransport.Interface) NewPauseFollow
• type PauseFollow
  • func New(tp elastictransport.Interface) *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) MasterTimeout(duration string) *PauseFollow
  • func (r PauseFollow) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PauseFollow) Pretty(pretty bool) *PauseFollow
• 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 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

Pause a follower.

Pause a cross-cluster replication follower index. The follower index will not fetch any additional operations from the leader index. You can resume following with the resume follower API. You can pause and resume a follower index to change the configuration of the following task.

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

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

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

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

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

func (*PauseFollow) Human

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) MasterTimeout

func (r *PauseFollow) MasterTimeout(duration string) *PauseFollow

MasterTimeout The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. API name: master_timeout

func (PauseFollow) Perform

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

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

func (*PauseFollow) Pretty

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

type Response

type Response struct {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

Response holds the response body struct for the package pausefollow

https://github.com/elastic/elasticsearch-specification/blob/470b4b9aaaa25cae633ec690e54b725c6fc939c7/specification/ccr/pause_follow/PauseFollowIndexResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response