api.nodes.info.go 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239
  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 newNodesInfoFunc(t Transport) NodesInfo {
  28. return func(o ...func(*NodesInfoRequest)) (*Response, error) {
  29. var r = NodesInfoRequest{}
  30. for _, f := range o {
  31. f(&r)
  32. }
  33. return r.Do(r.ctx, t)
  34. }
  35. }
  36. // ----- API Definition -------------------------------------------------------
  37. // NodesInfo returns information about nodes in the cluster.
  38. //
  39. // See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html.
  40. type NodesInfo func(o ...func(*NodesInfoRequest)) (*Response, error)
  41. // NodesInfoRequest configures the Nodes Info API request.
  42. type NodesInfoRequest struct {
  43. Metric []string
  44. NodeID []string
  45. FlatSettings *bool
  46. Timeout time.Duration
  47. Pretty bool
  48. Human bool
  49. ErrorTrace bool
  50. FilterPath []string
  51. Header http.Header
  52. ctx context.Context
  53. }
  54. // Do executes the request and returns response or error.
  55. func (r NodesInfoRequest) Do(ctx context.Context, transport Transport) (*Response, error) {
  56. var (
  57. method string
  58. path strings.Builder
  59. params map[string]string
  60. )
  61. method = "GET"
  62. path.Grow(1 + len("_nodes") + 1 + len(strings.Join(r.NodeID, ",")) + 1 + len(strings.Join(r.Metric, ",")))
  63. path.WriteString("/")
  64. path.WriteString("_nodes")
  65. if len(r.NodeID) > 0 {
  66. path.WriteString("/")
  67. path.WriteString(strings.Join(r.NodeID, ","))
  68. }
  69. if len(r.Metric) > 0 {
  70. path.WriteString("/")
  71. path.WriteString(strings.Join(r.Metric, ","))
  72. }
  73. params = make(map[string]string)
  74. if r.FlatSettings != nil {
  75. params["flat_settings"] = strconv.FormatBool(*r.FlatSettings)
  76. }
  77. if r.Timeout != 0 {
  78. params["timeout"] = formatDuration(r.Timeout)
  79. }
  80. if r.Pretty {
  81. params["pretty"] = "true"
  82. }
  83. if r.Human {
  84. params["human"] = "true"
  85. }
  86. if r.ErrorTrace {
  87. params["error_trace"] = "true"
  88. }
  89. if len(r.FilterPath) > 0 {
  90. params["filter_path"] = strings.Join(r.FilterPath, ",")
  91. }
  92. req, err := newRequest(method, path.String(), nil)
  93. if err != nil {
  94. return nil, err
  95. }
  96. if len(params) > 0 {
  97. q := req.URL.Query()
  98. for k, v := range params {
  99. q.Set(k, v)
  100. }
  101. req.URL.RawQuery = q.Encode()
  102. }
  103. if len(r.Header) > 0 {
  104. if len(req.Header) == 0 {
  105. req.Header = r.Header
  106. } else {
  107. for k, vv := range r.Header {
  108. for _, v := range vv {
  109. req.Header.Add(k, v)
  110. }
  111. }
  112. }
  113. }
  114. if ctx != nil {
  115. req = req.WithContext(ctx)
  116. }
  117. res, err := transport.Perform(req)
  118. if err != nil {
  119. return nil, err
  120. }
  121. response := Response{
  122. StatusCode: res.StatusCode,
  123. Body: res.Body,
  124. Header: res.Header,
  125. }
  126. return &response, nil
  127. }
  128. // WithContext sets the request context.
  129. func (f NodesInfo) WithContext(v context.Context) func(*NodesInfoRequest) {
  130. return func(r *NodesInfoRequest) {
  131. r.ctx = v
  132. }
  133. }
  134. // WithMetric - a list of metrics you wish returned. leave empty to return all metrics..
  135. func (f NodesInfo) WithMetric(v ...string) func(*NodesInfoRequest) {
  136. return func(r *NodesInfoRequest) {
  137. r.Metric = v
  138. }
  139. }
  140. // WithNodeID - a list of node ids or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
  141. func (f NodesInfo) WithNodeID(v ...string) func(*NodesInfoRequest) {
  142. return func(r *NodesInfoRequest) {
  143. r.NodeID = v
  144. }
  145. }
  146. // WithFlatSettings - return settings in flat format (default: false).
  147. func (f NodesInfo) WithFlatSettings(v bool) func(*NodesInfoRequest) {
  148. return func(r *NodesInfoRequest) {
  149. r.FlatSettings = &v
  150. }
  151. }
  152. // WithTimeout - explicit operation timeout.
  153. func (f NodesInfo) WithTimeout(v time.Duration) func(*NodesInfoRequest) {
  154. return func(r *NodesInfoRequest) {
  155. r.Timeout = v
  156. }
  157. }
  158. // WithPretty makes the response body pretty-printed.
  159. func (f NodesInfo) WithPretty() func(*NodesInfoRequest) {
  160. return func(r *NodesInfoRequest) {
  161. r.Pretty = true
  162. }
  163. }
  164. // WithHuman makes statistical values human-readable.
  165. func (f NodesInfo) WithHuman() func(*NodesInfoRequest) {
  166. return func(r *NodesInfoRequest) {
  167. r.Human = true
  168. }
  169. }
  170. // WithErrorTrace includes the stack trace for errors in the response body.
  171. func (f NodesInfo) WithErrorTrace() func(*NodesInfoRequest) {
  172. return func(r *NodesInfoRequest) {
  173. r.ErrorTrace = true
  174. }
  175. }
  176. // WithFilterPath filters the properties of the response body.
  177. func (f NodesInfo) WithFilterPath(v ...string) func(*NodesInfoRequest) {
  178. return func(r *NodesInfoRequest) {
  179. r.FilterPath = v
  180. }
  181. }
  182. // WithHeader adds the headers to the HTTP request.
  183. func (f NodesInfo) WithHeader(h map[string]string) func(*NodesInfoRequest) {
  184. return func(r *NodesInfoRequest) {
  185. if r.Header == nil {
  186. r.Header = make(http.Header)
  187. }
  188. for k, v := range h {
  189. r.Header.Add(k, v)
  190. }
  191. }
  192. }
  193. // WithOpaqueID adds the X-Opaque-Id header to the HTTP request.
  194. func (f NodesInfo) WithOpaqueID(s string) func(*NodesInfoRequest) {
  195. return func(r *NodesInfoRequest) {
  196. if r.Header == nil {
  197. r.Header = make(http.Header)
  198. }
  199. r.Header.Set("X-Opaque-Id", s)
  200. }
  201. }