deletedatafeed

Documentation

Overview

Deletes an existing datafeed.

Index

• Variables
• type DeleteDatafeed
  • func New(tp elastictransport.Interface) *DeleteDatafeed
  • func (r *DeleteDatafeed) DatafeedId(datafeedid string) *DeleteDatafeed
  • func (r DeleteDatafeed) Do(ctx context.Context) (*Response, error)
  • func (r *DeleteDatafeed) Force(force bool) *DeleteDatafeed
  • func (r *DeleteDatafeed) Header(key, value string) *DeleteDatafeed
  • func (r *DeleteDatafeed) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r DeleteDatafeed) IsSuccess(ctx context.Context) (bool, error)
  • func (r DeleteDatafeed) Perform(ctx context.Context) (*http.Response, error)
• type NewDeleteDatafeed
  • func NewDeleteDatafeedFunc(tp elastictransport.Interface) NewDeleteDatafeed
• type Response
  • func NewResponse() *Response

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 DeleteDatafeed

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

func New

func New(tp elastictransport.Interface) *DeleteDatafeed

Deletes an existing datafeed.

https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-delete-datafeed.html

func (*DeleteDatafeed) DatafeedId

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

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 (DeleteDatafeed) Do

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

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

func (*DeleteDatafeed) Force

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

Force Use to forcefully delete a started datafeed; this method is quicker than stopping and deleting the datafeed. API name: force

func (*DeleteDatafeed) Header

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

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

func (*DeleteDatafeed) HttpRequest

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

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

func (DeleteDatafeed) IsSuccess

func (r DeleteDatafeed) IsSuccess(ctx context.Context) (bool, error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.

func (DeleteDatafeed) Perform

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

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

type NewDeleteDatafeed

type NewDeleteDatafeed func(datafeedid string) *DeleteDatafeed

NewDeleteDatafeed type alias for index.

func NewDeleteDatafeedFunc

func NewDeleteDatafeedFunc(tp elastictransport.Interface) NewDeleteDatafeed

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

type Response

type Response struct {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response