api.xpack.ml.update_job.go 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202
  1. // Licensed to Elasticsearch B.V. under one or more contributor
  2. // license agreements. See the NOTICE file distributed with
  3. // this work for additional information regarding copyright
  4. // ownership. Elasticsearch B.V. licenses this file to you under
  5. // the Apache License, Version 2.0 (the "License"); you may
  6. // not use this file except in compliance with the License.
  7. // You may obtain a copy of the License at
  8. //
  9. // http://www.apache.org/licenses/LICENSE-2.0
  10. //
  11. // Unless required by applicable law or agreed to in writing,
  12. // software distributed under the License is distributed on an
  13. // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  14. // KIND, either express or implied. See the License for the
  15. // specific language governing permissions and limitations
  16. // under the License.
  17. //
  18. // Code generated from specification version 7.17.10: DO NOT EDIT
  19. package esapi
  20. import (
  21. "context"
  22. "io"
  23. "net/http"
  24. "strings"
  25. )
  26. func newMLUpdateJobFunc(t Transport) MLUpdateJob {
  27. return func(job_id string, body io.Reader, o ...func(*MLUpdateJobRequest)) (*Response, error) {
  28. var r = MLUpdateJobRequest{JobID: job_id, Body: body}
  29. for _, f := range o {
  30. f(&r)
  31. }
  32. return r.Do(r.ctx, t)
  33. }
  34. }
  35. // ----- API Definition -------------------------------------------------------
  36. // MLUpdateJob - Updates certain properties of an anomaly detection job.
  37. //
  38. // See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html.
  39. type MLUpdateJob func(job_id string, body io.Reader, o ...func(*MLUpdateJobRequest)) (*Response, error)
  40. // MLUpdateJobRequest configures the ML Update Job API request.
  41. type MLUpdateJobRequest struct {
  42. Body io.Reader
  43. JobID string
  44. Pretty bool
  45. Human bool
  46. ErrorTrace bool
  47. FilterPath []string
  48. Header http.Header
  49. ctx context.Context
  50. }
  51. // Do executes the request and returns response or error.
  52. func (r MLUpdateJobRequest) Do(ctx context.Context, transport Transport) (*Response, error) {
  53. var (
  54. method string
  55. path strings.Builder
  56. params map[string]string
  57. )
  58. method = "POST"
  59. path.Grow(1 + len("_ml") + 1 + len("anomaly_detectors") + 1 + len(r.JobID) + 1 + len("_update"))
  60. path.WriteString("/")
  61. path.WriteString("_ml")
  62. path.WriteString("/")
  63. path.WriteString("anomaly_detectors")
  64. path.WriteString("/")
  65. path.WriteString(r.JobID)
  66. path.WriteString("/")
  67. path.WriteString("_update")
  68. params = make(map[string]string)
  69. if r.Pretty {
  70. params["pretty"] = "true"
  71. }
  72. if r.Human {
  73. params["human"] = "true"
  74. }
  75. if r.ErrorTrace {
  76. params["error_trace"] = "true"
  77. }
  78. if len(r.FilterPath) > 0 {
  79. params["filter_path"] = strings.Join(r.FilterPath, ",")
  80. }
  81. req, err := newRequest(method, path.String(), r.Body)
  82. if err != nil {
  83. return nil, err
  84. }
  85. if len(params) > 0 {
  86. q := req.URL.Query()
  87. for k, v := range params {
  88. q.Set(k, v)
  89. }
  90. req.URL.RawQuery = q.Encode()
  91. }
  92. if len(r.Header) > 0 {
  93. if len(req.Header) == 0 {
  94. req.Header = r.Header
  95. } else {
  96. for k, vv := range r.Header {
  97. for _, v := range vv {
  98. req.Header.Add(k, v)
  99. }
  100. }
  101. }
  102. }
  103. if r.Body != nil && req.Header.Get(headerContentType) == "" {
  104. req.Header[headerContentType] = headerContentTypeJSON
  105. }
  106. if ctx != nil {
  107. req = req.WithContext(ctx)
  108. }
  109. res, err := transport.Perform(req)
  110. if err != nil {
  111. return nil, err
  112. }
  113. response := Response{
  114. StatusCode: res.StatusCode,
  115. Body: res.Body,
  116. Header: res.Header,
  117. }
  118. return &response, nil
  119. }
  120. // WithContext sets the request context.
  121. func (f MLUpdateJob) WithContext(v context.Context) func(*MLUpdateJobRequest) {
  122. return func(r *MLUpdateJobRequest) {
  123. r.ctx = v
  124. }
  125. }
  126. // WithPretty makes the response body pretty-printed.
  127. func (f MLUpdateJob) WithPretty() func(*MLUpdateJobRequest) {
  128. return func(r *MLUpdateJobRequest) {
  129. r.Pretty = true
  130. }
  131. }
  132. // WithHuman makes statistical values human-readable.
  133. func (f MLUpdateJob) WithHuman() func(*MLUpdateJobRequest) {
  134. return func(r *MLUpdateJobRequest) {
  135. r.Human = true
  136. }
  137. }
  138. // WithErrorTrace includes the stack trace for errors in the response body.
  139. func (f MLUpdateJob) WithErrorTrace() func(*MLUpdateJobRequest) {
  140. return func(r *MLUpdateJobRequest) {
  141. r.ErrorTrace = true
  142. }
  143. }
  144. // WithFilterPath filters the properties of the response body.
  145. func (f MLUpdateJob) WithFilterPath(v ...string) func(*MLUpdateJobRequest) {
  146. return func(r *MLUpdateJobRequest) {
  147. r.FilterPath = v
  148. }
  149. }
  150. // WithHeader adds the headers to the HTTP request.
  151. func (f MLUpdateJob) WithHeader(h map[string]string) func(*MLUpdateJobRequest) {
  152. return func(r *MLUpdateJobRequest) {
  153. if r.Header == nil {
  154. r.Header = make(http.Header)
  155. }
  156. for k, v := range h {
  157. r.Header.Add(k, v)
  158. }
  159. }
  160. }
  161. // WithOpaqueID adds the X-Opaque-Id header to the HTTP request.
  162. func (f MLUpdateJob) WithOpaqueID(s string) func(*MLUpdateJobRequest) {
  163. return func(r *MLUpdateJobRequest) {
  164. if r.Header == nil {
  165. r.Header = make(http.Header)
  166. }
  167. r.Header.Set("X-Opaque-Id", s)
  168. }
  169. }