ackwatch

Documentation

Overview

Acknowledges a watch, manually throttling the execution of the watch's actions.

Index

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

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

func New

func New(tp elastictransport.Interface) *AckWatch

Acknowledges a watch, manually throttling the execution of the watch's actions.

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

func (*AckWatch) ActionId

func (r *AckWatch) ActionId(actionid string) *AckWatch

ActionId A comma-separated list of the action ids to be acked API Name: actionid

func (AckWatch) Do

func (r AckWatch) Do(ctx context.Context) (*Response, error)

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

func (*AckWatch) Header

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

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

func (*AckWatch) HttpRequest

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

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

func (AckWatch) IsSuccess

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

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

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

func (*AckWatch) WatchId

func (r *AckWatch) WatchId(watchid string) *AckWatch

WatchId Watch ID API Name: watchid

type NewAckWatch

type NewAckWatch func(watchid string) *AckWatch

NewAckWatch type alias for index.

func NewAckWatchFunc

func NewAckWatchFunc(tp elastictransport.Interface) NewAckWatch

NewAckWatchFunc returns a new instance of AckWatch 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.WatchStatus `json:"status"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response