The highest tagged major version is
Documentation
¶
Overview ¶
Delete a rollup job.
A job must be stopped before it can be deleted. If you attempt to delete a started job, an error occurs. Similarly, if you attempt to delete a nonexistent job, an exception occurs.
IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. The API does not delete any previously rolled up data. This is by design; a user may wish to roll up a static data set. Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). Thus the job can be deleted, leaving behind the rolled up data for analysis. If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example:
``` POST my_rollup_index/_delete_by_query
{
"query": {
"term": {
"_rollup.id": "the_rollup_job_id"
}
}
}
```
Index ¶
- Variables
- type DeleteJob
- func (r DeleteJob) Do(providedCtx context.Context) (*Response, error)
- func (r *DeleteJob) ErrorTrace(errortrace bool) *DeleteJob
- func (r *DeleteJob) FilterPath(filterpaths ...string) *DeleteJob
- func (r *DeleteJob) Header(key, value string) *DeleteJob
- func (r *DeleteJob) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *DeleteJob) Human(human bool) *DeleteJob
- func (r DeleteJob) IsSuccess(providedCtx context.Context) (bool, error)
- func (r DeleteJob) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *DeleteJob) Pretty(pretty bool) *DeleteJob
- type NewDeleteJob
- 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 DeleteJob ¶
type DeleteJob struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *DeleteJob
Delete a rollup job.
A job must be stopped before it can be deleted. If you attempt to delete a started job, an error occurs. Similarly, if you attempt to delete a nonexistent job, an exception occurs.
IMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data. The API does not delete any previously rolled up data. This is by design; a user may wish to roll up a static data set. Because the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data). Thus the job can be deleted, leaving behind the rolled up data for analysis. If you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index. If the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example:
``` POST my_rollup_index/_delete_by_query
{
"query": {
"term": {
"_rollup.id": "the_rollup_job_id"
}
}
}
```
https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-delete-job.html
func (DeleteJob) Do ¶
Do runs the request through the transport, handle the response and returns a deletejob.Response
func (*DeleteJob) ErrorTrace ¶ added in v8.14.0
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*DeleteJob) FilterPath ¶ added in v8.14.0
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*DeleteJob) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*DeleteJob) Human ¶ added in v8.14.0
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 (DeleteJob) 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.
type NewDeleteJob ¶
NewDeleteJob type alias for index.
func NewDeleteJobFunc ¶
func NewDeleteJobFunc(tp elastictransport.Interface) NewDeleteJob
NewDeleteJobFunc returns a new instance of DeleteJob 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 struct {
Acknowledged bool `json:"acknowledged"`
TaskFailures []types.TaskFailure `json:"task_failures,omitempty"`
}
Response holds the response body struct for the package deletejob
Source Files