deletedataframeanalytics

Documentation

Overview

Deletes an existing data frame analytics job.

Index

• Variables
• type DeleteDataFrameAnalytics
  • func New(tp elastictransport.Interface) *DeleteDataFrameAnalytics
  • func (r DeleteDataFrameAnalytics) Do(providedCtx context.Context) (*Response, error)
  • func (r *DeleteDataFrameAnalytics) Force(force bool) *DeleteDataFrameAnalytics
  • func (r *DeleteDataFrameAnalytics) Header(key, value string) *DeleteDataFrameAnalytics
  • func (r *DeleteDataFrameAnalytics) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r DeleteDataFrameAnalytics) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r DeleteDataFrameAnalytics) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *DeleteDataFrameAnalytics) Timeout(duration string) *DeleteDataFrameAnalytics
• type NewDeleteDataFrameAnalytics
  • func NewDeleteDataFrameAnalyticsFunc(tp elastictransport.Interface) NewDeleteDataFrameAnalytics
• 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 DeleteDataFrameAnalytics

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

func New

func New(tp elastictransport.Interface) *DeleteDataFrameAnalytics

Deletes an existing data frame analytics job.

https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html

func (DeleteDataFrameAnalytics) Do

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

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

func (*DeleteDataFrameAnalytics) Force

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

Force If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job. API name: force

func (*DeleteDataFrameAnalytics) Header

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

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

func (*DeleteDataFrameAnalytics) HttpRequest

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

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

func (DeleteDataFrameAnalytics) IsSuccess

func (r DeleteDataFrameAnalytics) IsSuccess(providedCtx 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 (DeleteDataFrameAnalytics) Perform

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

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

func (*DeleteDataFrameAnalytics) Timeout

func (r *DeleteDataFrameAnalytics) Timeout(duration string) *DeleteDataFrameAnalytics

Timeout The time to wait for the job to be deleted. API name: timeout

type NewDeleteDataFrameAnalytics

type NewDeleteDataFrameAnalytics func(id string) *DeleteDataFrameAnalytics

NewDeleteDataFrameAnalytics type alias for index.

func NewDeleteDataFrameAnalyticsFunc

func NewDeleteDataFrameAnalyticsFunc(tp elastictransport.Interface) NewDeleteDataFrameAnalytics

NewDeleteDataFrameAnalyticsFunc returns a new instance of DeleteDataFrameAnalytics 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"`
}

Response holds the response body struct for the package deletedataframeanalytics

https://github.com/elastic/elasticsearch-specification/blob/b7d4fb5356784b8bcde8d3a2d62a1fd5621ffd67/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response