Documentation
¶
Overview ¶
Returns information about the tasks currently executing on one or more nodes in the cluster.
Index ¶
- Variables
- type NewTasks
- type Response
- type Tasks
- func (r *Tasks) Actions(actions ...string) *Tasks
- func (r *Tasks) Detailed(detailed bool) *Tasks
- func (r Tasks) Do(providedCtx context.Context) (Response, error)
- func (r *Tasks) Header(key, value string) *Tasks
- func (r *Tasks) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r Tasks) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *Tasks) NodeId(nodeids ...string) *Tasks
- func (r *Tasks) ParentTaskId(parenttaskid string) *Tasks
- func (r Tasks) Perform(providedCtx context.Context) (*http.Response, error)
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 NewTasks ¶
type NewTasks func() *Tasks
NewTasks type alias for index.
func NewTasksFunc ¶
func NewTasksFunc(tp elastictransport.Interface) NewTasks
NewTasksFunc returns a new instance of Tasks 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 []types.TasksRecord
type Tasks ¶
type Tasks struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Tasks
Returns information about the tasks currently executing on one or more nodes in the cluster.
https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html
func (*Tasks) Actions ¶
Actions The task action names, which are used to limit the response. API name: actions
func (*Tasks) Detailed ¶
Detailed If `true`, the response includes detailed information about shard recoveries. API name: detailed
func (Tasks) Do ¶
Do runs the request through the transport, handle the response and returns a tasks.Response
func (*Tasks) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (Tasks) 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 (*Tasks) NodeId ¶
NodeId Unique node identifiers, which are used to limit the response. API name: node_id
func (*Tasks) ParentTaskId ¶ added in v8.10.0
ParentTaskId The parent task identifier, which is used to limit the response. API name: parent_task_id
Source Files