Documentation
¶
Overview ¶
Retrieves configuration information for anomaly detection jobs.
Index ¶
- Variables
- type GetJobs
- func (r *GetJobs) AllowNoMatch(allownomatch bool) *GetJobs
- func (r GetJobs) Do(providedCtx context.Context) (*Response, error)
- func (r *GetJobs) ExcludeGenerated(excludegenerated bool) *GetJobs
- func (r *GetJobs) Header(key, value string) *GetJobs
- func (r *GetJobs) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r GetJobs) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *GetJobs) JobId(jobid string) *GetJobs
- func (r GetJobs) Perform(providedCtx context.Context) (*http.Response, error)
- type NewGetJobs
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
Types ¶
type GetJobs ¶
type GetJobs struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetJobs
Retrieves configuration information for anomaly detection jobs.
https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html
func (*GetJobs) AllowNoMatch ¶
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.
The default value is `true`, which returns an empty `jobs` array when there are no matches and the subset of results when there are partial matches. If this parameter is `false`, the request returns a `404` status code when there are no matches or only partial matches. API name: allow_no_match
func (GetJobs) Do ¶
Do runs the request through the transport, handle the response and returns a getjobs.Response
func (*GetJobs) ExcludeGenerated ¶
ExcludeGenerated Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster. API name: exclude_generated
func (*GetJobs) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (GetJobs) IsSuccess ¶
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.
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.
Source Files