Documentation
¶
Overview ¶
Starts an existing, stopped rollup job.
Index ¶
- Variables
- type NewStartJob
- type Response
- type StartJob
- func (r StartJob) Do(providedCtx context.Context) (*Response, error)
- func (r *StartJob) Header(key, value string) *StartJob
- func (r *StartJob) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r StartJob) IsSuccess(providedCtx context.Context) (bool, error)
- func (r StartJob) Perform(providedCtx context.Context) (*http.Response, error)
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 NewStartJob ¶
NewStartJob type alias for index.
func NewStartJobFunc ¶
func NewStartJobFunc(tp elastictransport.Interface) NewStartJob
NewStartJobFunc returns a new instance of StartJob 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 {
Started bool `json:"started"`
}
Response holds the response body struct for the package startjob
type StartJob ¶
type StartJob struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *StartJob
Starts an existing, stopped rollup job.
https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-start-job.html
func (StartJob) Do ¶
Do runs the request through the transport, handle the response and returns a startjob.Response
func (*StartJob) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
Source Files
Click to show internal directories.
Click to hide internal directories.