Documentation
¶
Overview ¶
Retrieves the configuration, stats, and status of rollup jobs.
Index ¶
- Variables
- type GetJobs
- func (r GetJobs) Do(providedCtx context.Context) (*Response, error)
- func (r *GetJobs) Header(key, value string) *GetJobs
- func (r *GetJobs) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *GetJobs) Id(id string) *GetJobs
- func (r GetJobs) IsSuccess(providedCtx context.Context) (bool, error)
- func (r GetJobs) Perform(providedCtx context.Context) (*http.Response, error)
- type NewGetJobs
- type Response
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 GetJobs ¶
type GetJobs struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetJobs
Retrieves the configuration, stats, and status of rollup jobs.
https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-get-job.html
func (GetJobs) Do ¶
Do runs the request through the transport, handle the response and returns a getjobs.Response
func (*GetJobs) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*GetJobs) Id ¶
Id Identifier for the rollup job. If it is `_all` or omitted, the API returns all rollup jobs. API Name: id
type NewGetJobs ¶
type NewGetJobs func() *GetJobs
NewGetJobs type alias for index.
func NewGetJobsFunc ¶
func NewGetJobsFunc(tp elastictransport.Interface) NewGetJobs
NewGetJobsFunc returns a new instance of GetJobs with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
Source Files