The highest tagged major version isv9.
start
package
This package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
- Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
- Tagged version
Modules with tagged versions give importers more predictable builds.
- Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Open Source Insights
Documentation¶
Overview¶
Start the watch service.Start the Watcher service if it is not already running.
Index¶
- Variables
- type NewStart
- type Response
- type Start
- func (r Start) Do(providedCtx context.Context) (*Response, error)
- func (r *Start) ErrorTrace(errortrace bool) *Start
- func (r *Start) FilterPath(filterpaths ...string) *Start
- func (r *Start) Header(key, value string) *Start
- func (r *Start) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Start) Human(human bool) *Start
- func (r Start) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *Start) MasterTimeout(duration string) *Start
- func (r Start) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Start) Pretty(pretty bool) *Start
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¶
typeNewStart¶
type NewStart func() *Start
NewStart type alias for index.
funcNewStartFunc¶
func NewStartFunc(tpelastictransport.Interface)NewStart
NewStartFunc returns a new instance of Start with the provided transport.Used in the index of the library this allows to retrieve every apis in once place.
typeResponse¶added inv8.7.0
type Response struct {// Acknowledged For a successful response, this value is always true. On failure, an// exception is returned instead.Acknowledgedbool `json:"acknowledged"`}Response holds the response body struct for the package start
typeStart¶
type Start struct {// contains filtered or unexported fields}funcNew¶
func New(tpelastictransport.Interface) *Start
Start the watch service.Start the Watcher service if it is not already running.
https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-start
func (Start)Do¶
Do runs the request through the transport, handle the response and returns a start.Response
func (*Start)ErrorTrace¶added inv8.14.0
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errorswhen they occur.API name: error_trace
func (*Start)FilterPath¶added inv8.14.0
FilterPath Comma-separated list of filters in dot notation which reduce the responsereturned by Elasticsearch.API name: filter_path
func (*Start)HttpRequest¶
HttpRequest returns the http.Request object built from thegiven parameters.
func (*Start)Human¶added inv8.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 humanreadable values will be omitted. This makes sense for responses beingconsumedonly by machines.API name: human
func (Start)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 (*Start)MasterTimeout¶added inv8.18.0
MasterTimeout Period to wait for a connection to the master node.API name: master_timeout
Source Files