stopdatafeed

Documentation

Overview

Stops one or more datafeeds.

Index

• Variables
• type NewStopDatafeed
  • func NewStopDatafeedFunc(tp elastictransport.Interface) NewStopDatafeed
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response
• type StopDatafeed
  • func New(tp elastictransport.Interface) *StopDatafeed
  • func (r *StopDatafeed) AllowNoMatch(b bool) *StopDatafeed
  • func (r *StopDatafeed) DatafeedId(v string) *StopDatafeed
  • func (r StopDatafeed) Do(ctx context.Context) (*Response, error)
  • func (r *StopDatafeed) Force(b bool) *StopDatafeed
  • func (r *StopDatafeed) Header(key, value string) *StopDatafeed
  • func (r *StopDatafeed) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r StopDatafeed) Perform(ctx context.Context) (*http.Response, error)
  • func (r *StopDatafeed) Raw(raw io.Reader) *StopDatafeed
  • func (r *StopDatafeed) Request(req *Request) *StopDatafeed
  • func (r *StopDatafeed) Timeout(v string) *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/1ad7fe36297b3a8e187b2259dedaf68a47bc236e/specification/ml/stop_datafeed/MlStopDatafeedRequest.ts#L24-L78

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

type Response

type Response struct {
	Stopped bool `json:"stopped"`
}

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

Stops one or more datafeeds.

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

func (*StopDatafeed) AllowNoMatch

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

AllowNoMatch Specifies what to do when the request:

* Contains wildcard expressions and there are no datafeeds that match. * Contains the `_all` string or no identifiers and there are no matches. * Contains wildcard expressions and there are only partial matches.

If `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches. API name: allow_no_match

func (*StopDatafeed) DatafeedId

func (r *StopDatafeed) DatafeedId(v string) *StopDatafeed

DatafeedId Identifier for the datafeed. You can stop multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can close all datafeeds by using `_all` or by specifying `*` as the identifier. API Name: datafeedid

func (StopDatafeed) Do

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

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

func (*StopDatafeed) Force

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

Force If `true`, the datafeed is stopped forcefully. 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) Perform

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

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

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(v string) *StopDatafeed

Timeout Specifies the amount of time to wait until a datafeed stops. API name: timeout