Documentation
¶
Overview ¶
Stop rollup jobs. If you try to stop a job that does not exist, an exception occurs. If you try to stop a job that is already stopped, nothing happens.
Since only a stopped job can be deleted, it can be useful to block the API until the indexer has fully stopped. This is accomplished with the `wait_for_completion` query parameter, and optionally a timeout. For example:
``` POST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s ``` The parameter blocks the API call from returning until either the job has moved to STOPPED or the specified time has elapsed. If the specified time elapses without the job moving to STOPPED, a timeout exception occurs.
Index ¶
- Variables
- type NewStopJob
- type Response
- type StopJob
- func (r StopJob) Do(providedCtx context.Context) (*Response, error)
- func (r *StopJob) ErrorTrace(errortrace bool) *StopJob
- func (r *StopJob) FilterPath(filterpaths ...string) *StopJob
- func (r *StopJob) Header(key, value string) *StopJob
- func (r *StopJob) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *StopJob) Human(human bool) *StopJob
- func (r StopJob) IsSuccess(providedCtx context.Context) (bool, error)
- func (r StopJob) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *StopJob) Pretty(pretty bool) *StopJob
- func (r *StopJob) Timeout(duration string) *StopJob
- func (r *StopJob) WaitForCompletion(waitforcompletion bool) *StopJob
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
Types ¶
type NewStopJob ¶
NewStopJob type alias for index.
func NewStopJobFunc ¶
func NewStopJobFunc(tp elastictransport.Interface) NewStopJob
NewStopJobFunc returns a new instance of StopJob with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Response ¶ added in v8.7.0
type Response struct {
Stopped bool `json:"stopped"`
}
Response holds the response body struct for the package stopjob
type StopJob ¶
type StopJob struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *StopJob
Stop rollup jobs. If you try to stop a job that does not exist, an exception occurs. If you try to stop a job that is already stopped, nothing happens.
Since only a stopped job can be deleted, it can be useful to block the API until the indexer has fully stopped. This is accomplished with the `wait_for_completion` query parameter, and optionally a timeout. For example:
``` POST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s ``` The parameter blocks the API call from returning until either the job has moved to STOPPED or the specified time has elapsed. If the specified time elapses without the job moving to STOPPED, a timeout exception occurs.
https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-stop-job.html
func (StopJob) Do ¶
Do runs the request through the transport, handle the response and returns a stopjob.Response
func (*StopJob) ErrorTrace ¶ added in v8.14.0
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*StopJob) FilterPath ¶ added in v8.14.0
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*StopJob) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*StopJob) Human ¶ added in v8.14.0
Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human
func (StopJob) IsSuccess ¶
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 (StopJob) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*StopJob) Pretty ¶ added in v8.14.0
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*StopJob) Timeout ¶
Timeout If `wait_for_completion` is `true`, the API blocks for (at maximum) the specified duration while waiting for the job to stop. If more than `timeout` time has passed, the API throws a timeout exception. NOTE: Even if a timeout occurs, the stop request is still processing and eventually moves the job to STOPPED. The timeout simply means the API call itself timed out while waiting for the status change. API name: timeout
func (*StopJob) WaitForCompletion ¶
WaitForCompletion If set to `true`, causes the API to block until the indexer state completely stops. If set to `false`, the API returns immediately and the indexer is stopped asynchronously in the background. API name: wait_for_completion
Source Files
