pausefollow

Documentation

Overview

Pauses a follower index. The follower index will not fetch any additional operations from the leader index.

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

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

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

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

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/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/ccr/pause_follow/PauseFollowIndexResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response