stopdataframeanalytics

Documentation

Overview

Stops one or more data frame analytics jobs.

Index

• Variables
• type NewStopDataFrameAnalytics
  • func NewStopDataFrameAnalyticsFunc(tp elastictransport.Interface) NewStopDataFrameAnalytics
• type Response
  • func NewResponse() *Response
• type StopDataFrameAnalytics
  • func New(tp elastictransport.Interface) *StopDataFrameAnalytics
  • func (r *StopDataFrameAnalytics) AllowNoMatch(b bool) *StopDataFrameAnalytics
  • func (r StopDataFrameAnalytics) Do(ctx context.Context) (*Response, error)
  • func (r *StopDataFrameAnalytics) Force(b bool) *StopDataFrameAnalytics
  • func (r *StopDataFrameAnalytics) Header(key, value string) *StopDataFrameAnalytics
  • func (r *StopDataFrameAnalytics) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *StopDataFrameAnalytics) Id(v string) *StopDataFrameAnalytics
  • func (r StopDataFrameAnalytics) IsSuccess(ctx context.Context) (bool, error)
  • func (r StopDataFrameAnalytics) Perform(ctx context.Context) (*http.Response, error)
  • func (r *StopDataFrameAnalytics) Timeout(v string) *StopDataFrameAnalytics

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 NewStopDataFrameAnalytics

type NewStopDataFrameAnalytics func(id string) *StopDataFrameAnalytics

NewStopDataFrameAnalytics type alias for index.

func NewStopDataFrameAnalyticsFunc

func NewStopDataFrameAnalyticsFunc(tp elastictransport.Interface) NewStopDataFrameAnalytics

NewStopDataFrameAnalyticsFunc returns a new instance of StopDataFrameAnalytics 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 {
	Stopped bool `json:"stopped"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type StopDataFrameAnalytics

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

func New

func New(tp elastictransport.Interface) *StopDataFrameAnalytics

Stops one or more data frame analytics jobs.

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

func (*StopDataFrameAnalytics) AllowNoMatch

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

AllowNoMatch Specifies what to do when the request:

1. Contains wildcard expressions and there are no data frame analytics jobs that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches.

The default value is true, which returns an empty data_frame_analytics array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches. API name: allow_no_match

func (StopDataFrameAnalytics) Do

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

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

func (*StopDataFrameAnalytics) Force

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

Force If true, the data frame analytics job is stopped forcefully. API name: force

func (*StopDataFrameAnalytics) Header

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

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

func (*StopDataFrameAnalytics) HttpRequest

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

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

func (*StopDataFrameAnalytics) Id

func (r *StopDataFrameAnalytics) Id(v string) *StopDataFrameAnalytics

Id Identifier for the data frame analytics job. 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: id

func (StopDataFrameAnalytics) IsSuccess

func (r StopDataFrameAnalytics) 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 (StopDataFrameAnalytics) Perform

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

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

func (*StopDataFrameAnalytics) Timeout

func (r *StopDataFrameAnalytics) Timeout(v string) *StopDataFrameAnalytics

Timeout Controls the amount of time to wait until the data frame analytics job stops. Defaults to 20 seconds. API name: timeout