cancel

Documentation

Overview

Cancel a task.

WARNING: The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible.

A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away. It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation. The get task information API will continue to list these cancelled tasks until they complete. The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible.

To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running. You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task.

Index

• Variables
• type Cancel
  • func New(tp elastictransport.Interface) *Cancel
  • func (r *Cancel) Actions(actions ...string) *Cancel
  • func (r Cancel) Do(providedCtx context.Context) (*Response, error)
  • func (r *Cancel) ErrorTrace(errortrace bool) *Cancel
  • func (r *Cancel) FilterPath(filterpaths ...string) *Cancel
  • func (r *Cancel) Header(key, value string) *Cancel
  • func (r *Cancel) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Cancel) Human(human bool) *Cancel
  • func (r Cancel) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *Cancel) Nodes(nodes ...string) *Cancel
  • func (r *Cancel) ParentTaskId(parenttaskid string) *Cancel
  • func (r Cancel) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Cancel) Pretty(pretty bool) *Cancel
  • func (r *Cancel) TaskId(taskid string) *Cancel
  • func (r *Cancel) WaitForCompletion(waitforcompletion bool) *Cancel
• type NewCancel
  • func NewCancelFunc(tp elastictransport.Interface) NewCancel
• type Response
  • func NewResponse() *Response
  • func (s *Response) UnmarshalJSON(data []byte) error

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 Cancel

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

func New

func New(tp elastictransport.Interface) *Cancel

Cancel a task.

WARNING: The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible.

A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away. It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation. The get task information API will continue to list these cancelled tasks until they complete. The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible.

To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running. You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task.

https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html

func (*Cancel) Actions

func (r *Cancel) Actions(actions ...string) *Cancel

Actions A comma-separated list or wildcard expression of actions that is used to limit the request. API name: actions

func (Cancel) Do

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

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

func (*Cancel) ErrorTrace

func (r *Cancel) ErrorTrace(errortrace bool) *Cancel

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*Cancel) FilterPath

func (r *Cancel) FilterPath(filterpaths ...string) *Cancel

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*Cancel) Header

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

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

func (*Cancel) HttpRequest

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

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

func (*Cancel) Human

func (r *Cancel) Human(human bool) *Cancel

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 (Cancel) IsSuccess

func (r Cancel) 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 (*Cancel) Nodes

func (r *Cancel) Nodes(nodes ...string) *Cancel

Nodes A comma-separated list of node IDs or names that is used to limit the request. API name: nodes

func (*Cancel) ParentTaskId

func (r *Cancel) ParentTaskId(parenttaskid string) *Cancel

ParentTaskId A parent task ID that is used to limit the tasks. API name: parent_task_id

func (Cancel) Perform

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

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

func (*Cancel) Pretty

func (r *Cancel) Pretty(pretty bool) *Cancel

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

func (*Cancel) TaskId

func (r *Cancel) TaskId(taskid string) *Cancel

TaskId The task identifier. API Name: taskid

func (*Cancel) WaitForCompletion

func (r *Cancel) WaitForCompletion(waitforcompletion bool) *Cancel

WaitForCompletion If true, the request blocks until all found tasks are complete. API name: wait_for_completion

type NewCancel

type NewCancel func() *Cancel

NewCancel type alias for index.

func NewCancelFunc

func NewCancelFunc(tp elastictransport.Interface) NewCancel

NewCancelFunc returns a new instance of Cancel 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 {
	NodeFailures []types.ErrorCause `json:"node_failures,omitempty"`
	// Nodes Task information grouped by node, if `group_by` was set to `node` (the
	// default).
	Nodes        map[string]types.NodeTasks `json:"nodes,omitempty"`
	TaskFailures []types.TaskFailure        `json:"task_failures,omitempty"`
	// Tasks Either a flat list of tasks if `group_by` was set to `none`, or grouped by
	// parents if
	// `group_by` was set to `parents`.
	Tasks types.TaskInfos `json:"tasks,omitempty"`
}

Response holds the response body struct for the package cancel

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/tasks/cancel/CancelTasksResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

func (*Response) UnmarshalJSON

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