getjobstats

Documentation

Overview

Retrieves usage information for anomaly detection jobs.

Index

• Variables
• type GetJobStats
  • func New(tp elastictransport.Interface) *GetJobStats
  • func (r *GetJobStats) AllowNoMatch(allownomatch bool) *GetJobStats
  • func (r GetJobStats) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetJobStats) Header(key, value string) *GetJobStats
  • func (r *GetJobStats) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r GetJobStats) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *GetJobStats) JobId(jobid string) *GetJobStats
  • func (r GetJobStats) Perform(providedCtx context.Context) (*http.Response, error)
• type NewGetJobStats
  • func NewGetJobStatsFunc(tp elastictransport.Interface) NewGetJobStats
• 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 GetJobStats

type GetJobStats struct {
	// contains filtered or unexported fields
}

func New

func New(tp elastictransport.Interface) *GetJobStats

Retrieves usage information for anomaly detection jobs.

https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html

func (*GetJobStats) AllowNoMatch

func (r *GetJobStats) AllowNoMatch(allownomatch bool) *GetJobStats

AllowNoMatch Specifies what to do when the request:

1. Contains wildcard expressions and there are no jobs that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches.

If `true`, the API returns an empty `jobs` array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a `404` status code when there are no matches or only partial matches. API name: allow_no_match

func (GetJobStats) Do

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

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

func (*GetJobStats) Header

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

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

func (*GetJobStats) HttpRequest

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

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

func (GetJobStats) IsSuccess

func (r GetJobStats) 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 (*GetJobStats) JobId

func (r *GetJobStats) JobId(jobid string) *GetJobStats

JobId Identifier for the anomaly detection job. It can be a job identifier, a group name, a comma-separated list of jobs, or a wildcard expression. If you do not specify one of these options, the API returns information for all anomaly detection jobs. API Name: jobid

func (GetJobStats) Perform

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

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

type NewGetJobStats

type NewGetJobStats func() *GetJobStats

NewGetJobStats type alias for index.

func NewGetJobStatsFunc

func NewGetJobStatsFunc(tp elastictransport.Interface) NewGetJobStats

NewGetJobStatsFunc returns a new instance of GetJobStats 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 {
	Count int64            `json:"count"`
	Jobs  []types.JobStats `json:"jobs"`
}

Response holds the response body struct for the package getjobstats

https://github.com/elastic/elasticsearch-specification/blob/b2c13a00c152a97cb41193deda8ed9b37fd06796/specification/ml/get_job_stats/MlGetJobStatsResponse.ts#L23-L28

func NewResponse

func NewResponse() *Response

NewResponse returns a Response