closejob

Documentation

Overview

Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle.

Index

• Variables
• type CloseJob
  • func New(tp elastictransport.Interface) *CloseJob
  • func (r *CloseJob) AllowNoMatch(allownomatch bool) *CloseJob
  • func (r CloseJob) Do(ctx context.Context) (*Response, error)
  • func (r *CloseJob) Force(force bool) *CloseJob
  • func (r *CloseJob) Header(key, value string) *CloseJob
  • func (r *CloseJob) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *CloseJob) JobId(jobid string) *CloseJob
  • func (r CloseJob) Perform(ctx context.Context) (*http.Response, error)
  • func (r *CloseJob) Raw(raw io.Reader) *CloseJob
  • func (r *CloseJob) Request(req *Request) *CloseJob
  • func (r *CloseJob) Timeout(duration types.Duration) *CloseJob
• type NewCloseJob
  • func NewCloseJobFunc(tp elastictransport.Interface) NewCloseJob
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• 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 CloseJob

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

func New

func New(tp elastictransport.Interface) *CloseJob

Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle.

https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ml-close-job.html

func (*CloseJob) AllowNoMatch

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

AllowNoMatch Refer to the description for the `allow_no_match` query parameter. API name: allow_no_match

func (CloseJob) Do

func (r CloseJob) Do(ctx context.Context) (*Response, error)

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

func (*CloseJob) Force

func (r *CloseJob) Force(force bool) *CloseJob

Force Refer to the descriptiion for the `force` query parameter. API name: force

func (*CloseJob) Header

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

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

func (*CloseJob) HttpRequest

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

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

func (*CloseJob) JobId

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

JobId Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can close all jobs by using `_all` or by specifying `*` as the job identifier. API Name: jobid

func (CloseJob) Perform

func (r CloseJob) Perform(ctx context.Context) (*http.Response, error)

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

func (*CloseJob) Raw

func (r *CloseJob) Raw(raw io.Reader) *CloseJob

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*CloseJob) Request

func (r *CloseJob) Request(req *Request) *CloseJob

Request allows to set the request property with the appropriate payload.

func (*CloseJob) Timeout

func (r *CloseJob) Timeout(duration types.Duration) *CloseJob

Timeout Refer to the description for the `timeout` query parameter. API name: timeout

type NewCloseJob

type NewCloseJob func(jobid string) *CloseJob

NewCloseJob type alias for index.

func NewCloseJobFunc

func NewCloseJobFunc(tp elastictransport.Interface) NewCloseJob

NewCloseJobFunc returns a new instance of CloseJob with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Request

type Request struct {

	// AllowNoMatch Refer to the description for the `allow_no_match` query parameter.
	AllowNoMatch *bool `json:"allow_no_match,omitempty"`
	// Force Refer to the descriptiion for the `force` query parameter.
	Force *bool `json:"force,omitempty"`
	// Timeout Refer to the description for the `timeout` query parameter.
	Timeout types.Duration `json:"timeout,omitempty"`
}

Request holds the request body struct for the package closejob

https://github.com/elastic/elasticsearch-specification/blob/b89646a75dd9e8001caf92d22bd8b3704c59dfdf/specification/ml/close_job/MlCloseJobRequest.ts#L24-L77

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

type Response

type Response struct {
	Closed bool `json:"closed"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response