deactivatewatch

Documentation

Overview

Deactivates a currently active watch.

Index

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

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

func New

func New(tp elastictransport.Interface) *DeactivateWatch

Deactivates a currently active watch.

https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html

func (DeactivateWatch) Do

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

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

func (*DeactivateWatch) ErrorTrace

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

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

func (*DeactivateWatch) FilterPath

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

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

func (*DeactivateWatch) Header

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

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

func (*DeactivateWatch) HttpRequest

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

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

func (*DeactivateWatch) Human

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

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

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

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

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

func (*DeactivateWatch) Pretty

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

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

type NewDeactivateWatch

type NewDeactivateWatch func(watchid string) *DeactivateWatch

NewDeactivateWatch type alias for index.

func NewDeactivateWatchFunc

func NewDeactivateWatchFunc(tp elastictransport.Interface) NewDeactivateWatch

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

type Response

type Response struct {
	Status types.ActivationStatus `json:"status"`
}

Response holds the response body struct for the package deactivatewatch

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/watcher/deactivate_watch/DeactivateWatchResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response