activatewatch

Documentation

Overview

Activates a currently inactive watch.

Index

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

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

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

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

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

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

func (*ActivateWatch) WatchId

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

WatchId Watch ID API Name: watchid

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response