putwatch

Documentation

Overview

Creates a new watch, or updates an existing one.

Index

• Variables
• type NewPutWatch
  • func NewPutWatchFunc(tp elastictransport.Interface) NewPutWatch
• type PutWatch
  • func New(tp elastictransport.Interface) *PutWatch
  • func (r *PutWatch) Actions(actions map[string]types.WatcherAction) *PutWatch
  • func (r *PutWatch) Active(active bool) *PutWatch
  • func (r *PutWatch) Condition(condition *types.WatcherCondition) *PutWatch
  • func (r PutWatch) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutWatch) ErrorTrace(errortrace bool) *PutWatch
  • func (r *PutWatch) FilterPath(filterpaths ...string) *PutWatch
  • func (r *PutWatch) Header(key, value string) *PutWatch
  • func (r *PutWatch) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutWatch) Human(human bool) *PutWatch
  • func (r *PutWatch) IfPrimaryTerm(ifprimaryterm string) *PutWatch
  • func (r *PutWatch) IfSeqNo(sequencenumber string) *PutWatch
  • func (r *PutWatch) Input(input *types.WatcherInput) *PutWatch
  • func (r *PutWatch) Metadata(metadata types.Metadata) *PutWatch
  • func (r PutWatch) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutWatch) Pretty(pretty bool) *PutWatch
  • func (r *PutWatch) Raw(raw io.Reader) *PutWatch
  • func (r *PutWatch) Request(req *Request) *PutWatch
  • func (r *PutWatch) ThrottlePeriod(throttleperiod string) *PutWatch
  • func (r *PutWatch) Transform(transform *types.TransformContainer) *PutWatch
  • func (r *PutWatch) Trigger(trigger *types.TriggerContainer) *PutWatch
  • func (r *PutWatch) Version(versionnumber string) *PutWatch
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
  • func (s *Request) UnmarshalJSON(data []byte) error
• 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 NewPutWatch

type NewPutWatch func(id string) *PutWatch

NewPutWatch type alias for index.

func NewPutWatchFunc

func NewPutWatchFunc(tp elastictransport.Interface) NewPutWatch

NewPutWatchFunc returns a new instance of PutWatch with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type PutWatch

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

func New

func New(tp elastictransport.Interface) *PutWatch

Creates a new watch, or updates an existing one.

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

func (*PutWatch) Actions

func (r *PutWatch) Actions(actions map[string]types.WatcherAction) *PutWatch

API name: actions

func (*PutWatch) Active

func (r *PutWatch) Active(active bool) *PutWatch

Active Specify whether the watch is in/active by default API name: active

func (*PutWatch) Condition

func (r *PutWatch) Condition(condition *types.WatcherCondition) *PutWatch

API name: condition

func (PutWatch) Do

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

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

func (*PutWatch) ErrorTrace

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

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

func (*PutWatch) FilterPath

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

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

func (*PutWatch) Header

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

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

func (*PutWatch) HttpRequest

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

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

func (*PutWatch) Human

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

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 (*PutWatch) IfPrimaryTerm

func (r *PutWatch) IfPrimaryTerm(ifprimaryterm string) *PutWatch

IfPrimaryTerm only update the watch if the last operation that has changed the watch has the specified primary term API name: if_primary_term

func (*PutWatch) IfSeqNo

func (r *PutWatch) IfSeqNo(sequencenumber string) *PutWatch

IfSeqNo only update the watch if the last operation that has changed the watch has the specified sequence number API name: if_seq_no

func (*PutWatch) Input

func (r *PutWatch) Input(input *types.WatcherInput) *PutWatch

API name: input

func (*PutWatch) Metadata

func (r *PutWatch) Metadata(metadata types.Metadata) *PutWatch

API name: metadata

func (PutWatch) Perform

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

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

func (*PutWatch) Pretty

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

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

func (*PutWatch) Raw

func (r *PutWatch) Raw(raw io.Reader) *PutWatch

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*PutWatch) Request

func (r *PutWatch) Request(req *Request) *PutWatch

Request allows to set the request property with the appropriate payload.

func (*PutWatch) ThrottlePeriod

func (r *PutWatch) ThrottlePeriod(throttleperiod string) *PutWatch

API name: throttle_period

func (*PutWatch) Transform

func (r *PutWatch) Transform(transform *types.TransformContainer) *PutWatch

API name: transform

func (*PutWatch) Trigger

func (r *PutWatch) Trigger(trigger *types.TriggerContainer) *PutWatch

API name: trigger

func (*PutWatch) Version

func (r *PutWatch) Version(versionnumber string) *PutWatch

Version Explicit version number for concurrency control API name: version

type Request

type Request struct {
	Actions        map[string]types.WatcherAction `json:"actions,omitempty"`
	Condition      *types.WatcherCondition        `json:"condition,omitempty"`
	Input          *types.WatcherInput            `json:"input,omitempty"`
	Metadata       types.Metadata                 `json:"metadata,omitempty"`
	ThrottlePeriod *string                        `json:"throttle_period,omitempty"`
	Transform      *types.TransformContainer      `json:"transform,omitempty"`
	Trigger        *types.TriggerContainer        `json:"trigger,omitempty"`
}

Request holds the request body struct for the package putwatch

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/watcher/put_watch/WatcherPutWatchRequest.ts#L30-L53

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*Request) UnmarshalJSON

func (s *Request) UnmarshalJSON(data []byte) error

type Response

type Response struct {
	Created      bool   `json:"created"`
	Id_          string `json:"_id"`
	PrimaryTerm_ int64  `json:"_primary_term"`
	SeqNo_       int64  `json:"_seq_no"`
	Version_     int64  `json:"_version"`
}

Response holds the response body struct for the package putwatch

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/watcher/put_watch/WatcherPutWatchResponse.ts#L23-L31

func NewResponse

func NewResponse() *Response

NewResponse returns a Response