openjob

Documentation

Overview

Opens one or more anomaly detection jobs.

Index

• Variables
• type NewOpenJob
  • func NewOpenJobFunc(tp elastictransport.Interface) NewOpenJob
• type OpenJob
  • func New(tp elastictransport.Interface) *OpenJob
  • func (r OpenJob) Do(ctx context.Context) (*Response, error)
  • func (r *OpenJob) Header(key, value string) *OpenJob
  • func (r *OpenJob) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r OpenJob) Perform(ctx context.Context) (*http.Response, error)
  • func (r *OpenJob) Raw(raw io.Reader) *OpenJob
  • func (r *OpenJob) Request(req *Request) *OpenJob
  • func (r *OpenJob) Timeout(duration types.Duration) *OpenJob
• 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 NewOpenJob

type NewOpenJob func(jobid string) *OpenJob

NewOpenJob type alias for index.

func NewOpenJobFunc

func NewOpenJobFunc(tp elastictransport.Interface) NewOpenJob

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

type OpenJob

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

func New

func New(tp elastictransport.Interface) *OpenJob

Opens one or more anomaly detection jobs.

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

func (OpenJob) Do

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

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

func (*OpenJob) Header

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

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

func (*OpenJob) HttpRequest

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

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

func (OpenJob) Perform

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

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

func (*OpenJob) Raw

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

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

func (*OpenJob) Request

func (r *OpenJob) Request(req *Request) *OpenJob

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

func (*OpenJob) Timeout

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

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

type Request

type Request struct {

	// 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 openjob

https://github.com/elastic/elasticsearch-specification/blob/ac9c431ec04149d9048f2b8f9731e3c2f7f38754/specification/ml/open_job/MlOpenJobRequest.ts#L24-L59

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 {

	// Node The ID of the node that the job was started on. In serverless this will be
	// the "serverless".
	// If the job is allowed to open lazily and has not yet been assigned to a node,
	// this value is an empty string.
	Node   string `json:"node"`
	Opened bool   `json:"opened"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response