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) Active(b bool) *PutWatch
  • func (r PutWatch) Do(ctx context.Context) (*http.Response, error)
  • func (r *PutWatch) Header(key, value string) *PutWatch
  • func (r *PutWatch) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutWatch) Id(v string) *PutWatch
  • func (r *PutWatch) IfPrimaryTerm(value string) *PutWatch
  • func (r *PutWatch) IfSeqNo(value string) *PutWatch
  • func (r *PutWatch) Raw(raw json.RawMessage) *PutWatch
  • func (r *PutWatch) Request(req *Request) *PutWatch
  • func (r *PutWatch) Version(value string) *PutWatch
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Actions(values map[string]*types.ActionBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) Condition(condition *types.ConditionContainerBuilder) *RequestBuilder
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) Input(input *types.InputContainerBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Metadata(metadata *types.MetadataBuilder) *RequestBuilder
  • func (rb *RequestBuilder) ThrottlePeriod(throttleperiod string) *RequestBuilder
  • func (rb *RequestBuilder) Transform(transform *types.TransformContainerBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Trigger(trigger *types.TriggerContainerBuilder) *RequestBuilder

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

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

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

func (PutWatch) Do

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

Do runs the http.Request through the provided transport.

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

func (r *PutWatch) Id(v string) *PutWatch

Id Watch ID API Name: id

func (*PutWatch) IfPrimaryTerm

func (r *PutWatch) IfPrimaryTerm(value 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(value 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) Raw

func (r *PutWatch) Raw(raw json.RawMessage) *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) Version

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

Version Explicit version number for concurrency control API name: version

type Request

type Request struct {
	Actions map[string]types.Action `json:"actions,omitempty"`

	Condition *types.ConditionContainer `json:"condition,omitempty"`

	Input *types.InputContainer `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/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/watcher/put_watch/WatcherPutWatchRequest.ts#L30-L54

type RequestBuilder

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

RequestBuilder is the builder API for the putwatch.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Actions

func (rb *RequestBuilder) Actions(values map[string]*types.ActionBuilder) *RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) Condition

func (rb *RequestBuilder) Condition(condition *types.ConditionContainerBuilder) *RequestBuilder

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) Input

func (rb *RequestBuilder) Input(input *types.InputContainerBuilder) *RequestBuilder

func (*RequestBuilder) Metadata

func (rb *RequestBuilder) Metadata(metadata *types.MetadataBuilder) *RequestBuilder

func (*RequestBuilder) ThrottlePeriod

func (rb *RequestBuilder) ThrottlePeriod(throttleperiod string) *RequestBuilder

func (*RequestBuilder) Transform

func (rb *RequestBuilder) Transform(transform *types.TransformContainerBuilder) *RequestBuilder

func (*RequestBuilder) Trigger

func (rb *RequestBuilder) Trigger(trigger *types.TriggerContainerBuilder) *RequestBuilder