Documentation
¶
Overview ¶
Returns a list of any cluster-level changes (e.g. create index, update mapping, allocate or fail shard) which have not yet been executed.
Index ¶
- Variables
- type NewPendingTasks
- type PendingTasks
- func (r PendingTasks) Do(providedCtx context.Context) (*Response, error)
- func (r *PendingTasks) Header(key, value string) *PendingTasks
- func (r *PendingTasks) HttpRequest(ctx context.Context) (*http.Request, error)
- 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)
- type Response
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 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
Returns a list of any cluster-level changes (e.g. create index, update mapping, allocate or fail shard) which have not yet been executed.
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) Header ¶
func (r *PendingTasks) Header(key, value string) *PendingTasks
Header set a key, value pair in the PendingTasks headers map.
func (*PendingTasks) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
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
type Response ¶ added in v8.7.0
type Response struct {
Tasks []types.PendingTask `json:"tasks"`
}
Response holds the response body struct for the package pendingtasks
Source Files