cancel

Documentation

Overview

Cancels a task, if it can be cancelled through an API.

Index

• Variables
• type Cancel
  • func New(tp elastictransport.Interface) *Cancel
  • func (r *Cancel) Actions(value string) *Cancel
  • func (r Cancel) Do(ctx context.Context) (*http.Response, error)
  • func (r *Cancel) Header(key, value string) *Cancel
  • func (r *Cancel) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r Cancel) IsSuccess(ctx context.Context) (bool, error)
  • func (r *Cancel) Nodes(value string) *Cancel
  • func (r *Cancel) ParentTaskId(value string) *Cancel
  • func (r *Cancel) TaskId(v string) *Cancel
  • func (r *Cancel) WaitForCompletion(b bool) *Cancel
• type NewCancel
  • func NewCancelFunc(tp elastictransport.Interface) NewCancel

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

Cancels a task, if it can be cancelled through an API.

https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/tasks.html

func (*Cancel) Actions

func (r *Cancel) Actions(value string) *Cancel

Actions A comma-separated list of actions that should be cancelled. Leave empty to cancel all. API name: actions

func (Cancel) Do

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

Do runs the http.Request through the provided transport.

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

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

func (r *Cancel) Nodes(value string) *Cancel

Nodes A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes API name: nodes

func (*Cancel) ParentTaskId

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

ParentTaskId Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all. API name: parent_task_id

func (*Cancel) TaskId

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

TaskId Cancel the task with specified task id (node_id:task_number) API Name: taskid

func (*Cancel) WaitForCompletion

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

WaitForCompletion Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false 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.