pendingtasks

Documentation

Overview

Get the pending cluster tasks. Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect.

NOTE: This API returns a list of any pending updates to the cluster state. These are distinct from the tasks reported by the task management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.

Index

• Variables
• type NewPendingTasks
  • func NewPendingTasksFunc(tp elastictransport.Interface) NewPendingTasks
• type PendingTasks
  • func New(tp elastictransport.Interface) *PendingTasks
  • func (r PendingTasks) Do(providedCtx context.Context) (*Response, error)
  • func (r *PendingTasks) ErrorTrace(errortrace bool) *PendingTasks
  • func (r *PendingTasks) FilterPath(filterpaths ...string) *PendingTasks
  • func (r *PendingTasks) Header(key, value string) *PendingTasks
  • func (r *PendingTasks) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PendingTasks) Human(human bool) *PendingTasks
  • func (r PendingTasks) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *PendingTasks) Local(local bool) *PendingTasks
  • func (r *PendingTasks) MasterTimeout(duration string) *PendingTasks
  • func (r PendingTasks) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PendingTasks) Pretty(pretty bool) *PendingTasks
• 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 NewPendingTasks

type NewPendingTasks func() *PendingTasks

NewPendingTasks type alias for index.

func NewPendingTasksFunc

func NewPendingTasksFunc(tp elastictransport.Interface) NewPendingTasks

NewPendingTasksFunc returns a new instance of PendingTasks with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type PendingTasks

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

func New

func New(tp elastictransport.Interface) *PendingTasks

Get the pending cluster tasks. Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect.

NOTE: This API returns a list of any pending updates to the cluster state. These are distinct from the tasks reported by the task management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.

https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-pending.html

func (PendingTasks) Do

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

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

func (*PendingTasks) ErrorTrace

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

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

func (*PendingTasks) FilterPath

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

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

func (*PendingTasks) Header

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

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

func (*PendingTasks) HttpRequest

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

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

func (*PendingTasks) Human

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

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

func (r PendingTasks) 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 (*PendingTasks) Local

func (r *PendingTasks) Local(local bool) *PendingTasks

Local If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. API name: local

func (*PendingTasks) MasterTimeout

func (r *PendingTasks) MasterTimeout(duration string) *PendingTasks

MasterTimeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout

func (PendingTasks) Perform

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

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

func (*PendingTasks) Pretty

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

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

type Response

type Response struct {
	Tasks []types.PendingTask `json:"tasks"`
}

Response holds the response body struct for the package pendingtasks

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/cluster/pending_tasks/ClusterPendingTasksResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response