stopjob

package
v8.11.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 27, 2023 License: Apache-2.0 Imports: 13 Imported by: 4

Documentation

Overview

Stops an existing, started rollup job.

Index

Constants

This section is empty.

Variables

View Source
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

type NewStopJob func(id string) *StopJob

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

https://github.com/elastic/elasticsearch-specification/blob/5fea44e006349579bf3561a82e997002e5716117/specification/rollup/stop_job/StopRollupJobResponse.ts#L20-L22

func NewResponse added in v8.7.0

func NewResponse() *Response

NewResponse returns a Response

type StopJob

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

func (StopJob) Do

func (r StopJob) Do(ctx context.Context) (*Response, error)

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

func (*StopJob) Header

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

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

func (*StopJob) HttpRequest

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

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

func (StopJob) IsSuccess

func (r StopJob) IsSuccess(ctx 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 (StopJob) Perform added in v8.7.0

func (r StopJob) Perform(ctx context.Context) (*http.Response, error)

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

func (*StopJob) Timeout

func (r *StopJob) Timeout(duration string) *StopJob

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

func (r *StopJob) WaitForCompletion(waitforcompletion bool) *StopJob

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL