api.ingest.simulate.go 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225
  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. "strconv"
  25. "strings"
  26. )
  27. func newIngestSimulateFunc(t Transport) IngestSimulate {
  28. return func(body io.Reader, o ...func(*IngestSimulateRequest)) (*Response, error) {
  29. var r = IngestSimulateRequest{Body: body}
  30. for _, f := range o {
  31. f(&r)
  32. }
  33. return r.Do(r.ctx, t)
  34. }
  35. }
  36. // ----- API Definition -------------------------------------------------------
  37. // IngestSimulate allows to simulate a pipeline with example documents.
  38. //
  39. // See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html.
  40. type IngestSimulate func(body io.Reader, o ...func(*IngestSimulateRequest)) (*Response, error)
  41. // IngestSimulateRequest configures the Ingest Simulate API request.
  42. type IngestSimulateRequest struct {
  43. PipelineID string
  44. Body io.Reader
  45. Verbose *bool
  46. Pretty bool
  47. Human bool
  48. ErrorTrace bool
  49. FilterPath []string
  50. Header http.Header
  51. ctx context.Context
  52. }
  53. // Do executes the request and returns response or error.
  54. func (r IngestSimulateRequest) Do(ctx context.Context, transport Transport) (*Response, error) {
  55. var (
  56. method string
  57. path strings.Builder
  58. params map[string]string
  59. )
  60. method = "POST"
  61. path.Grow(1 + len("_ingest") + 1 + len("pipeline") + 1 + len(r.PipelineID) + 1 + len("_simulate"))
  62. path.WriteString("/")
  63. path.WriteString("_ingest")
  64. path.WriteString("/")
  65. path.WriteString("pipeline")
  66. if r.PipelineID != "" {
  67. path.WriteString("/")
  68. path.WriteString(r.PipelineID)
  69. }
  70. path.WriteString("/")
  71. path.WriteString("_simulate")
  72. params = make(map[string]string)
  73. if r.Verbose != nil {
  74. params["verbose"] = strconv.FormatBool(*r.Verbose)
  75. }
  76. if r.Pretty {
  77. params["pretty"] = "true"
  78. }
  79. if r.Human {
  80. params["human"] = "true"
  81. }
  82. if r.ErrorTrace {
  83. params["error_trace"] = "true"
  84. }
  85. if len(r.FilterPath) > 0 {
  86. params["filter_path"] = strings.Join(r.FilterPath, ",")
  87. }
  88. req, err := newRequest(method, path.String(), r.Body)
  89. if err != nil {
  90. return nil, err
  91. }
  92. if len(params) > 0 {
  93. q := req.URL.Query()
  94. for k, v := range params {
  95. q.Set(k, v)
  96. }
  97. req.URL.RawQuery = q.Encode()
  98. }
  99. if len(r.Header) > 0 {
  100. if len(req.Header) == 0 {
  101. req.Header = r.Header
  102. } else {
  103. for k, vv := range r.Header {
  104. for _, v := range vv {
  105. req.Header.Add(k, v)
  106. }
  107. }
  108. }
  109. }
  110. if r.Body != nil && req.Header.Get(headerContentType) == "" {
  111. req.Header[headerContentType] = headerContentTypeJSON
  112. }
  113. if ctx != nil {
  114. req = req.WithContext(ctx)
  115. }
  116. res, err := transport.Perform(req)
  117. if err != nil {
  118. return nil, err
  119. }
  120. response := Response{
  121. StatusCode: res.StatusCode,
  122. Body: res.Body,
  123. Header: res.Header,
  124. }
  125. return &response, nil
  126. }
  127. // WithContext sets the request context.
  128. func (f IngestSimulate) WithContext(v context.Context) func(*IngestSimulateRequest) {
  129. return func(r *IngestSimulateRequest) {
  130. r.ctx = v
  131. }
  132. }
  133. // WithPipelineID - pipeline ID.
  134. func (f IngestSimulate) WithPipelineID(v string) func(*IngestSimulateRequest) {
  135. return func(r *IngestSimulateRequest) {
  136. r.PipelineID = v
  137. }
  138. }
  139. // WithVerbose - verbose mode. display data output for each processor in executed pipeline.
  140. func (f IngestSimulate) WithVerbose(v bool) func(*IngestSimulateRequest) {
  141. return func(r *IngestSimulateRequest) {
  142. r.Verbose = &v
  143. }
  144. }
  145. // WithPretty makes the response body pretty-printed.
  146. func (f IngestSimulate) WithPretty() func(*IngestSimulateRequest) {
  147. return func(r *IngestSimulateRequest) {
  148. r.Pretty = true
  149. }
  150. }
  151. // WithHuman makes statistical values human-readable.
  152. func (f IngestSimulate) WithHuman() func(*IngestSimulateRequest) {
  153. return func(r *IngestSimulateRequest) {
  154. r.Human = true
  155. }
  156. }
  157. // WithErrorTrace includes the stack trace for errors in the response body.
  158. func (f IngestSimulate) WithErrorTrace() func(*IngestSimulateRequest) {
  159. return func(r *IngestSimulateRequest) {
  160. r.ErrorTrace = true
  161. }
  162. }
  163. // WithFilterPath filters the properties of the response body.
  164. func (f IngestSimulate) WithFilterPath(v ...string) func(*IngestSimulateRequest) {
  165. return func(r *IngestSimulateRequest) {
  166. r.FilterPath = v
  167. }
  168. }
  169. // WithHeader adds the headers to the HTTP request.
  170. func (f IngestSimulate) WithHeader(h map[string]string) func(*IngestSimulateRequest) {
  171. return func(r *IngestSimulateRequest) {
  172. if r.Header == nil {
  173. r.Header = make(http.Header)
  174. }
  175. for k, v := range h {
  176. r.Header.Add(k, v)
  177. }
  178. }
  179. }
  180. // WithOpaqueID adds the X-Opaque-Id header to the HTTP request.
  181. func (f IngestSimulate) WithOpaqueID(s string) func(*IngestSimulateRequest) {
  182. return func(r *IngestSimulateRequest) {
  183. if r.Header == nil {
  184. r.Header = make(http.Header)
  185. }
  186. r.Header.Set("X-Opaque-Id", s)
  187. }
  188. }