getjobs

Documentation

Overview

Retrieves the configuration, stats, and status of rollup jobs.

Index

• Variables
• type GetJobs
  • func New(tp elastictransport.Interface) *GetJobs
  • func (r GetJobs) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetJobs) ErrorTrace(errortrace bool) *GetJobs
  • func (r *GetJobs) FilterPath(filterpaths ...string) *GetJobs
  • func (r *GetJobs) Header(key, value string) *GetJobs
  • func (r *GetJobs) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetJobs) Human(human bool) *GetJobs
  • 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)
  • func (r *GetJobs) Pretty(pretty bool) *GetJobs
• type NewGetJobs
  • func NewGetJobsFunc(tp elastictransport.Interface) NewGetJobs
• type Response
  • func NewResponse() *Response

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.

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

func (r GetJobs) Do(providedCtx context.Context) (*Response, error)

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

func (*GetJobs) ErrorTrace

func (r *GetJobs) ErrorTrace(errortrace bool) *GetJobs

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*GetJobs) FilterPath

func (r *GetJobs) FilterPath(filterpaths ...string) *GetJobs

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*GetJobs) Header

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

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

func (*GetJobs) HttpRequest

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

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

func (*GetJobs) Human

func (r *GetJobs) Human(human bool) *GetJobs

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 human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (*GetJobs) Id

func (r *GetJobs) Id(id string) *GetJobs

Id Identifier for the rollup job. If it is `_all` or omitted, the API returns all rollup jobs. API Name: id

func (GetJobs) IsSuccess

func (r GetJobs) IsSuccess(providedCtx 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 (GetJobs) Perform

func (r GetJobs) Perform(providedCtx context.Context) (*http.Response, error)

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

func (*GetJobs) Pretty

func (r *GetJobs) Pretty(pretty bool) *GetJobs

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

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.

type Response

type Response struct {
	Jobs []types.RollupJob `json:"jobs"`
}

Response holds the response body struct for the package getjobs

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/rollup/get_jobs/GetRollupJobResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response