Documentation
¶
Overview ¶
Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin
Index ¶
- Variables
- type NewStop
- type Response
- type Stop
- func (r Stop) Do(providedCtx context.Context) (*Response, error)
- func (r *Stop) Header(key, value string) *Stop
- func (r *Stop) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r Stop) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *Stop) MasterTimeout(duration string) *Stop
- func (r Stop) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Stop) Timeout(duration string) *Stop
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 NewStop ¶
type NewStop func() *Stop
NewStop type alias for index.
func NewStopFunc ¶
func NewStopFunc(tp elastictransport.Interface) NewStop
NewStopFunc returns a new instance of Stop 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 For a successful response, this value is always true. On failure, an
// exception is returned instead.
Acknowledged bool `json:"acknowledged"`
}
Response holds the response body struct for the package stop
type Stop ¶
type Stop struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Stop
Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin
https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html
func (Stop) Do ¶
Do runs the request through the transport, handle the response and returns a stop.Response
func (*Stop) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (Stop) 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 (*Stop) MasterTimeout ¶
API name: master_timeout
Source Files