deactivatewatch

Documentation

Overview

Deactivates a currently active watch.

Index

• Variables
• type DeactivateWatch
  • func New(tp elastictransport.Interface) *DeactivateWatch
  • func (r DeactivateWatch) Do(ctx context.Context) (*Response, error)
  • func (r *DeactivateWatch) Header(key, value string) *DeactivateWatch
  • func (r *DeactivateWatch) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r DeactivateWatch) IsSuccess(ctx context.Context) (bool, error)
  • func (r DeactivateWatch) Perform(ctx context.Context) (*http.Response, error)
  • func (r *DeactivateWatch) WatchId(v string) *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(ctx context.Context) (*Response, error)

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

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

func (r DeactivateWatch) IsSuccess(ctx 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(ctx context.Context) (*http.Response, error)

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

func (*DeactivateWatch) WatchId

func (r *DeactivateWatch) WatchId(v string) *DeactivateWatch

WatchId Watch ID API Name: watchid

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"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response