stopdatafeed

Documentation

Overview

Stop datafeeds. A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle.

Index

• Variables
• type NewStopDatafeed
  • func NewStopDatafeedFunc(tp elastictransport.Interface) NewStopDatafeed
• 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
• type StopDatafeed
  • func New(tp elastictransport.Interface) *StopDatafeed
  • func (r *StopDatafeed) AllowNoMatch(allownomatch bool) *StopDatafeed
  • func (r StopDatafeed) Do(providedCtx context.Context) (*Response, error)
  • func (r *StopDatafeed) ErrorTrace(errortrace bool) *StopDatafeed
  • func (r *StopDatafeed) FilterPath(filterpaths ...string) *StopDatafeed
  • func (r *StopDatafeed) Force(force bool) *StopDatafeed
  • func (r *StopDatafeed) Header(key, value string) *StopDatafeed
  • func (r *StopDatafeed) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *StopDatafeed) Human(human bool) *StopDatafeed
  • func (r StopDatafeed) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *StopDatafeed) Pretty(pretty bool) *StopDatafeed
  • func (r *StopDatafeed) Raw(raw io.Reader) *StopDatafeed
  • func (r *StopDatafeed) Request(req *Request) *StopDatafeed
  • func (r *StopDatafeed) Timeout(duration types.Duration) *StopDatafeed

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 NewStopDatafeed

type NewStopDatafeed func(datafeedid string) *StopDatafeed

NewStopDatafeed type alias for index.

func NewStopDatafeedFunc

func NewStopDatafeedFunc(tp elastictransport.Interface) NewStopDatafeed

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

type Request

type Request struct {

	// AllowNoMatch Refer to the description for the `allow_no_match` query parameter.
	AllowNoMatch *bool `json:"allow_no_match,omitempty"`
	// Force Refer to the description for the `force` query parameter.
	Force *bool `json:"force,omitempty"`
	// Timeout Refer to the description for the `timeout` query parameter.
	Timeout types.Duration `json:"timeout,omitempty"`
}

Request holds the request body struct for the package stopdatafeed

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ml/stop_datafeed/MlStopDatafeedRequest.ts#L24-L79

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 {
	Stopped bool `json:"stopped"`
}

Response holds the response body struct for the package stopdatafeed

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ml/stop_datafeed/MlStopDatafeedResponse.ts#L20-L22

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type StopDatafeed

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

func New

func New(tp elastictransport.Interface) *StopDatafeed

Stop datafeeds. A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle.

https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html

func (*StopDatafeed) AllowNoMatch

func (r *StopDatafeed) AllowNoMatch(allownomatch bool) *StopDatafeed

AllowNoMatch Refer to the description for the `allow_no_match` query parameter. API name: allow_no_match

func (StopDatafeed) Do

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

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

func (*StopDatafeed) ErrorTrace

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

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

func (*StopDatafeed) FilterPath

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

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

func (*StopDatafeed) Force

func (r *StopDatafeed) Force(force bool) *StopDatafeed

Force Refer to the description for the `force` query parameter. API name: force

func (*StopDatafeed) Header

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

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

func (*StopDatafeed) HttpRequest

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

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

func (*StopDatafeed) Human

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

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 (StopDatafeed) Perform

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

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

func (*StopDatafeed) Pretty

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

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

func (*StopDatafeed) Raw

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

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

func (*StopDatafeed) Request

func (r *StopDatafeed) Request(req *Request) *StopDatafeed

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

func (*StopDatafeed) Timeout

func (r *StopDatafeed) Timeout(duration types.Duration) *StopDatafeed

Timeout Refer to the description for the `timeout` query parameter. API name: timeout