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) (*http.Response, error)
  • func (r *OpenJob) Header(key, value string) *OpenJob
  • func (r *OpenJob) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *OpenJob) JobId(v string) *OpenJob
  • func (r *OpenJob) Raw(raw json.RawMessage) *OpenJob
  • func (r *OpenJob) Request(req *Request) *OpenJob
  • func (r *OpenJob) Timeout(value string) *OpenJob
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) Timeout(timeout *types.DurationBuilder) *RequestBuilder

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) (*http.Response, error)

Do runs the http.Request through the provided transport.

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) JobId

func (r *OpenJob) JobId(v string) *OpenJob

JobId Identifier for the anomaly detection job. API Name: jobid

func (*OpenJob) Raw

func (r *OpenJob) Raw(raw json.RawMessage) *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(value string) *OpenJob

Timeout Controls the time to wait until a job has opened. 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/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/ml/open_job/MlOpenJobRequest.ts#L24-L59

type RequestBuilder

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

RequestBuilder is the builder API for the openjob.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) Timeout

func (rb *RequestBuilder) Timeout(timeout *types.DurationBuilder) *RequestBuilder