pauseautofollowpattern

Documentation

Overview

Pauses an auto-follow pattern

Index

• Variables
• type NewPauseAutoFollowPattern
  • func NewPauseAutoFollowPatternFunc(tp elastictransport.Interface) NewPauseAutoFollowPattern
• type PauseAutoFollowPattern
  • func New(tp elastictransport.Interface) *PauseAutoFollowPattern
  • func (r PauseAutoFollowPattern) Do(providedCtx context.Context) (*Response, error)
  • func (r *PauseAutoFollowPattern) ErrorTrace(errortrace bool) *PauseAutoFollowPattern
  • func (r *PauseAutoFollowPattern) FilterPath(filterpaths ...string) *PauseAutoFollowPattern
  • func (r *PauseAutoFollowPattern) Header(key, value string) *PauseAutoFollowPattern
  • func (r *PauseAutoFollowPattern) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PauseAutoFollowPattern) Human(human bool) *PauseAutoFollowPattern
  • func (r PauseAutoFollowPattern) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r PauseAutoFollowPattern) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PauseAutoFollowPattern) Pretty(pretty bool) *PauseAutoFollowPattern
• 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 NewPauseAutoFollowPattern

type NewPauseAutoFollowPattern func(name string) *PauseAutoFollowPattern

NewPauseAutoFollowPattern type alias for index.

func NewPauseAutoFollowPatternFunc

func NewPauseAutoFollowPatternFunc(tp elastictransport.Interface) NewPauseAutoFollowPattern

NewPauseAutoFollowPatternFunc returns a new instance of PauseAutoFollowPattern with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type PauseAutoFollowPattern

type PauseAutoFollowPattern struct {
	// contains filtered or unexported fields
}

func New

func New(tp elastictransport.Interface) *PauseAutoFollowPattern

Pauses an auto-follow pattern

https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-pause-auto-follow-pattern.html

func (PauseAutoFollowPattern) Do

func (r PauseAutoFollowPattern) Do(providedCtx context.Context) (*Response, error)

Do runs the request through the transport, handle the response and returns a pauseautofollowpattern.Response

func (*PauseAutoFollowPattern) ErrorTrace

func (r *PauseAutoFollowPattern) ErrorTrace(errortrace bool) *PauseAutoFollowPattern

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*PauseAutoFollowPattern) FilterPath

func (r *PauseAutoFollowPattern) FilterPath(filterpaths ...string) *PauseAutoFollowPattern

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*PauseAutoFollowPattern) Header

func (r *PauseAutoFollowPattern) Header(key, value string) *PauseAutoFollowPattern

Header set a key, value pair in the PauseAutoFollowPattern headers map.

func (*PauseAutoFollowPattern) HttpRequest

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

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

func (*PauseAutoFollowPattern) Human

func (r *PauseAutoFollowPattern) Human(human bool) *PauseAutoFollowPattern

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 (PauseAutoFollowPattern) IsSuccess

func (r PauseAutoFollowPattern) 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 (PauseAutoFollowPattern) Perform

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

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

func (*PauseAutoFollowPattern) Pretty

func (r *PauseAutoFollowPattern) Pretty(pretty bool) *PauseAutoFollowPattern

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 pauseautofollowpattern

https://github.com/elastic/elasticsearch-specification/blob/07bf82537a186562d8699685e3704ea338b268ef/specification/ccr/pause_auto_follow_pattern/PauseAutoFollowPatternResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response