Documentation
¶
Overview ¶
Stops an existing, started rollup job.
Index ¶
- Variables
- type NewStopJob
- type Response
- type StopJob
- func (r StopJob) Do(providedCtx context.Context) (*Response, error)
- func (r *StopJob) Header(key, value string) *StopJob
- func (r *StopJob) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r StopJob) IsSuccess(providedCtx context.Context) (bool, error)
- func (r StopJob) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *StopJob) Timeout(duration string) *StopJob
- func (r *StopJob) WaitForCompletion(waitforcompletion bool) *StopJob
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 NewStopJob ¶
NewStopJob type alias for index.
func NewStopJobFunc ¶
func NewStopJobFunc(tp elastictransport.Interface) NewStopJob
NewStopJobFunc returns a new instance of StopJob 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 {
Stopped bool `json:"stopped"`
}
Response holds the response body struct for the package stopjob
type StopJob ¶
type StopJob struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *StopJob
Stops an existing, started rollup job.
https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-stop-job.html
func (StopJob) Do ¶
Do runs the request through the transport, handle the response and returns a stopjob.Response
func (*StopJob) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (StopJob) 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 (StopJob) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*StopJob) Timeout ¶
Timeout If `wait_for_completion` is `true`, the API blocks for (at maximum) the specified duration while waiting for the job to stop. If more than `timeout` time has passed, the API throws a timeout exception. API name: timeout
func (*StopJob) WaitForCompletion ¶
WaitForCompletion If set to `true`, causes the API to block until the indexer state completely stops. If set to `false`, the API returns immediately and the indexer is stopped asynchronously in the background. API name: wait_for_completion
Source Files