deletewatch

Documentation

Overview

Removes a watch from Watcher.

Index

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

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

func New

func New(tp elastictransport.Interface) *DeleteWatch

Removes a watch from Watcher.

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

func (DeleteWatch) Do

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

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

func (*DeleteWatch) ErrorTrace

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

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

func (*DeleteWatch) FilterPath

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

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

func (*DeleteWatch) Header

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

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

func (*DeleteWatch) HttpRequest

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

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

func (*DeleteWatch) Human

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

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

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

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

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

func (*DeleteWatch) Pretty

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

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

type NewDeleteWatch

type NewDeleteWatch func(id string) *DeleteWatch

NewDeleteWatch type alias for index.

func NewDeleteWatchFunc

func NewDeleteWatchFunc(tp elastictransport.Interface) NewDeleteWatch

NewDeleteWatchFunc returns a new instance of DeleteWatch 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 {
	Found    bool   `json:"found"`
	Id_      string `json:"_id"`
	Version_ int64  `json:"_version"`
}

Response holds the response body struct for the package deletewatch

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/watcher/delete_watch/DeleteWatchResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response