putwatch

package
v8.13.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 11, 2024 License: Apache-2.0 Imports: 12 Imported by: 3

Documentation

Overview

Creates a new watch, or updates an existing one.

Index

Constants

This section is empty.

Variables

View Source 
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.

Functions

This section is empty.

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 added in v8.9.0 

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 added in v8.9.0 

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) 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) 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 added in v8.9.0 

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

API name: input

func (*PutWatch) Metadata added in v8.9.0 

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

API name: metadata

func (PutWatch) Perform added in v8.7.0 

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) 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 added in v8.9.0 

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

API name: throttle_period

func (*PutWatch) Transform added in v8.9.0 

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

API name: transform

func (*PutWatch) Trigger added in v8.9.0 

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/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/specification/watcher/put_watch/WatcherPutWatchRequest.ts#L30-L53

func NewRequest added in v8.5.0 

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON added in v8.5.0 

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

FromJSON allows to load an arbitrary json into the request structure

func (*Request) UnmarshalJSON added in v8.12.1 

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

type Response added in v8.7.0 

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/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/specification/watcher/put_watch/WatcherPutWatchResponse.ts#L23-L31

func NewResponse added in v8.7.0 

func NewResponse() *Response

NewResponse returns a Response

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.