api.ingest.get_pipeline.go 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229
  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. "net/http"
  23. "strconv"
  24. "strings"
  25. "time"
  26. )
  27. func newIngestGetPipelineFunc(t Transport) IngestGetPipeline {
  28. return func(o ...func(*IngestGetPipelineRequest)) (*Response, error) {
  29. var r = IngestGetPipelineRequest{}
  30. for _, f := range o {
  31. f(&r)
  32. }
  33. return r.Do(r.ctx, t)
  34. }
  35. }
  36. // ----- API Definition -------------------------------------------------------
  37. // IngestGetPipeline returns a pipeline.
  38. //
  39. // See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html.
  40. type IngestGetPipeline func(o ...func(*IngestGetPipelineRequest)) (*Response, error)
  41. // IngestGetPipelineRequest configures the Ingest Get Pipeline API request.
  42. type IngestGetPipelineRequest struct {
  43. PipelineID string
  44. MasterTimeout time.Duration
  45. Summary *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 IngestGetPipelineRequest) 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 = "GET"
  61. path.Grow(1 + len("_ingest") + 1 + len("pipeline") + 1 + len(r.PipelineID))
  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. params = make(map[string]string)
  71. if r.MasterTimeout != 0 {
  72. params["master_timeout"] = formatDuration(r.MasterTimeout)
  73. }
  74. if r.Summary != nil {
  75. params["summary"] = strconv.FormatBool(*r.Summary)
  76. }
  77. if r.Pretty {
  78. params["pretty"] = "true"
  79. }
  80. if r.Human {
  81. params["human"] = "true"
  82. }
  83. if r.ErrorTrace {
  84. params["error_trace"] = "true"
  85. }
  86. if len(r.FilterPath) > 0 {
  87. params["filter_path"] = strings.Join(r.FilterPath, ",")
  88. }
  89. req, err := newRequest(method, path.String(), nil)
  90. if err != nil {
  91. return nil, err
  92. }
  93. if len(params) > 0 {
  94. q := req.URL.Query()
  95. for k, v := range params {
  96. q.Set(k, v)
  97. }
  98. req.URL.RawQuery = q.Encode()
  99. }
  100. if len(r.Header) > 0 {
  101. if len(req.Header) == 0 {
  102. req.Header = r.Header
  103. } else {
  104. for k, vv := range r.Header {
  105. for _, v := range vv {
  106. req.Header.Add(k, v)
  107. }
  108. }
  109. }
  110. }
  111. if ctx != nil {
  112. req = req.WithContext(ctx)
  113. }
  114. res, err := transport.Perform(req)
  115. if err != nil {
  116. return nil, err
  117. }
  118. response := Response{
  119. StatusCode: res.StatusCode,
  120. Body: res.Body,
  121. Header: res.Header,
  122. }
  123. return &response, nil
  124. }
  125. // WithContext sets the request context.
  126. func (f IngestGetPipeline) WithContext(v context.Context) func(*IngestGetPipelineRequest) {
  127. return func(r *IngestGetPipelineRequest) {
  128. r.ctx = v
  129. }
  130. }
  131. // WithPipelineID - comma separated list of pipeline ids. wildcards supported.
  132. func (f IngestGetPipeline) WithPipelineID(v string) func(*IngestGetPipelineRequest) {
  133. return func(r *IngestGetPipelineRequest) {
  134. r.PipelineID = v
  135. }
  136. }
  137. // WithMasterTimeout - explicit operation timeout for connection to master node.
  138. func (f IngestGetPipeline) WithMasterTimeout(v time.Duration) func(*IngestGetPipelineRequest) {
  139. return func(r *IngestGetPipelineRequest) {
  140. r.MasterTimeout = v
  141. }
  142. }
  143. // WithSummary - return pipelines without their definitions (default: false).
  144. func (f IngestGetPipeline) WithSummary(v bool) func(*IngestGetPipelineRequest) {
  145. return func(r *IngestGetPipelineRequest) {
  146. r.Summary = &v
  147. }
  148. }
  149. // WithPretty makes the response body pretty-printed.
  150. func (f IngestGetPipeline) WithPretty() func(*IngestGetPipelineRequest) {
  151. return func(r *IngestGetPipelineRequest) {
  152. r.Pretty = true
  153. }
  154. }
  155. // WithHuman makes statistical values human-readable.
  156. func (f IngestGetPipeline) WithHuman() func(*IngestGetPipelineRequest) {
  157. return func(r *IngestGetPipelineRequest) {
  158. r.Human = true
  159. }
  160. }
  161. // WithErrorTrace includes the stack trace for errors in the response body.
  162. func (f IngestGetPipeline) WithErrorTrace() func(*IngestGetPipelineRequest) {
  163. return func(r *IngestGetPipelineRequest) {
  164. r.ErrorTrace = true
  165. }
  166. }
  167. // WithFilterPath filters the properties of the response body.
  168. func (f IngestGetPipeline) WithFilterPath(v ...string) func(*IngestGetPipelineRequest) {
  169. return func(r *IngestGetPipelineRequest) {
  170. r.FilterPath = v
  171. }
  172. }
  173. // WithHeader adds the headers to the HTTP request.
  174. func (f IngestGetPipeline) WithHeader(h map[string]string) func(*IngestGetPipelineRequest) {
  175. return func(r *IngestGetPipelineRequest) {
  176. if r.Header == nil {
  177. r.Header = make(http.Header)
  178. }
  179. for k, v := range h {
  180. r.Header.Add(k, v)
  181. }
  182. }
  183. }
  184. // WithOpaqueID adds the X-Opaque-Id header to the HTTP request.
  185. func (f IngestGetPipeline) WithOpaqueID(s string) func(*IngestGetPipelineRequest) {
  186. return func(r *IngestGetPipelineRequest) {
  187. if r.Header == nil {
  188. r.Header = make(http.Header)
  189. }
  190. r.Header.Set("X-Opaque-Id", s)
  191. }
  192. }