startdatafeed

Documentation

Overview

Starts one or more datafeeds.

Index

• Variables
• type NewStartDatafeed
  • func NewStartDatafeedFunc(tp elastictransport.Interface) NewStartDatafeed
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response
  • func (s *Response) UnmarshalJSON(data []byte) error
• type StartDatafeed
  • func New(tp elastictransport.Interface) *StartDatafeed
  • func (r *StartDatafeed) DatafeedId(datafeedid string) *StartDatafeed
  • func (r StartDatafeed) Do(ctx context.Context) (*Response, error)
  • func (r *StartDatafeed) End(datetime types.DateTime) *StartDatafeed
  • func (r *StartDatafeed) Header(key, value string) *StartDatafeed
  • func (r *StartDatafeed) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r StartDatafeed) Perform(ctx context.Context) (*http.Response, error)
  • func (r *StartDatafeed) Raw(raw io.Reader) *StartDatafeed
  • func (r *StartDatafeed) Request(req *Request) *StartDatafeed
  • func (r *StartDatafeed) Start(datetime types.DateTime) *StartDatafeed
  • func (r *StartDatafeed) Timeout(duration types.Duration) *StartDatafeed

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 NewStartDatafeed

type NewStartDatafeed func(datafeedid string) *StartDatafeed

NewStartDatafeed type alias for index.

func NewStartDatafeedFunc

func NewStartDatafeedFunc(tp elastictransport.Interface) NewStartDatafeed

NewStartDatafeedFunc returns a new instance of StartDatafeed 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 {

	// End Refer to the description for the `end` query parameter.
	End types.DateTime `json:"end,omitempty"`
	// Start Refer to the description for the `start` query parameter.
	Start types.DateTime `json:"start,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 startdatafeed

https://github.com/elastic/elasticsearch-specification/blob/3b09f9d8e90178243f8a340a7bc324aab152c602/specification/ml/start_datafeed/MlStartDatafeedRequest.ts#L24-L91

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 {

	// Node The ID of the node that the job was started on. In serverless this will be
	// the "serverless".
	// If the job is allowed to open lazily and has not yet been assigned to a node,
	// this value is an empty string.
	Node []string `json:"node"`
	// Started For a successful response, this value is always `true`. On failure, an
	// exception is returned instead.
	Started bool `json:"started"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

func (*Response) UnmarshalJSON

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

type StartDatafeed

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

func New

func New(tp elastictransport.Interface) *StartDatafeed

Starts one or more datafeeds.

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

func (*StartDatafeed) DatafeedId

func (r *StartDatafeed) DatafeedId(datafeedid string) *StartDatafeed

DatafeedId A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. API Name: datafeedid

func (StartDatafeed) Do

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

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

func (*StartDatafeed) End

func (r *StartDatafeed) End(datetime types.DateTime) *StartDatafeed

End Refer to the description for the `end` query parameter. API name: end

func (*StartDatafeed) Header

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

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

func (*StartDatafeed) HttpRequest

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

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

func (StartDatafeed) Perform

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

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

func (*StartDatafeed) Raw

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

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

func (*StartDatafeed) Request

func (r *StartDatafeed) Request(req *Request) *StartDatafeed

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

func (*StartDatafeed) Start

func (r *StartDatafeed) Start(datetime types.DateTime) *StartDatafeed

Start Refer to the description for the `start` query parameter. API name: start

func (*StartDatafeed) Timeout

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

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