activatewatch

Documentation

Overview

Activates a currently inactive watch.

Index

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

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

func New

func New(tp elastictransport.Interface) *ActivateWatch

Activates a currently inactive watch.

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

func (ActivateWatch) Do

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

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

func (*ActivateWatch) ErrorTrace

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

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

func (*ActivateWatch) FilterPath

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

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

func (*ActivateWatch) Header

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

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

func (*ActivateWatch) HttpRequest

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

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

func (*ActivateWatch) Human

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

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

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

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

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

func (*ActivateWatch) Pretty

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

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

type NewActivateWatch

type NewActivateWatch func(watchid string) *ActivateWatch

NewActivateWatch type alias for index.

func NewActivateWatchFunc

func NewActivateWatchFunc(tp elastictransport.Interface) NewActivateWatch

NewActivateWatchFunc returns a new instance of ActivateWatch 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 activatewatch

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response