api.cluster.stats.go 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231
  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 newClusterStatsFunc(t Transport) ClusterStats {
  28. return func(o ...func(*ClusterStatsRequest)) (*Response, error) {
  29. var r = ClusterStatsRequest{}
  30. for _, f := range o {
  31. f(&r)
  32. }
  33. return r.Do(r.ctx, t)
  34. }
  35. }
  36. // ----- API Definition -------------------------------------------------------
  37. // ClusterStats returns high-level overview of cluster statistics.
  38. //
  39. // See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html.
  40. type ClusterStats func(o ...func(*ClusterStatsRequest)) (*Response, error)
  41. // ClusterStatsRequest configures the Cluster Stats API request.
  42. type ClusterStatsRequest struct {
  43. NodeID []string
  44. FlatSettings *bool
  45. Timeout time.Duration
  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 ClusterStatsRequest) 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(len("/nodes/_cluster/stats/nodes/") + len(strings.Join(r.NodeID, ",")))
  62. path.WriteString("/")
  63. path.WriteString("_cluster")
  64. path.WriteString("/")
  65. path.WriteString("stats")
  66. if len(r.NodeID) > 0 {
  67. path.WriteString("/")
  68. path.WriteString("nodes")
  69. path.WriteString("/")
  70. path.WriteString(strings.Join(r.NodeID, ","))
  71. }
  72. params = make(map[string]string)
  73. if r.FlatSettings != nil {
  74. params["flat_settings"] = strconv.FormatBool(*r.FlatSettings)
  75. }
  76. if r.Timeout != 0 {
  77. params["timeout"] = formatDuration(r.Timeout)
  78. }
  79. if r.Pretty {
  80. params["pretty"] = "true"
  81. }
  82. if r.Human {
  83. params["human"] = "true"
  84. }
  85. if r.ErrorTrace {
  86. params["error_trace"] = "true"
  87. }
  88. if len(r.FilterPath) > 0 {
  89. params["filter_path"] = strings.Join(r.FilterPath, ",")
  90. }
  91. req, err := newRequest(method, path.String(), nil)
  92. if err != nil {
  93. return nil, err
  94. }
  95. if len(params) > 0 {
  96. q := req.URL.Query()
  97. for k, v := range params {
  98. q.Set(k, v)
  99. }
  100. req.URL.RawQuery = q.Encode()
  101. }
  102. if len(r.Header) > 0 {
  103. if len(req.Header) == 0 {
  104. req.Header = r.Header
  105. } else {
  106. for k, vv := range r.Header {
  107. for _, v := range vv {
  108. req.Header.Add(k, v)
  109. }
  110. }
  111. }
  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 ClusterStats) WithContext(v context.Context) func(*ClusterStatsRequest) {
  129. return func(r *ClusterStatsRequest) {
  130. r.ctx = v
  131. }
  132. }
  133. // 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.
  134. func (f ClusterStats) WithNodeID(v ...string) func(*ClusterStatsRequest) {
  135. return func(r *ClusterStatsRequest) {
  136. r.NodeID = v
  137. }
  138. }
  139. // WithFlatSettings - return settings in flat format (default: false).
  140. func (f ClusterStats) WithFlatSettings(v bool) func(*ClusterStatsRequest) {
  141. return func(r *ClusterStatsRequest) {
  142. r.FlatSettings = &v
  143. }
  144. }
  145. // WithTimeout - explicit operation timeout.
  146. func (f ClusterStats) WithTimeout(v time.Duration) func(*ClusterStatsRequest) {
  147. return func(r *ClusterStatsRequest) {
  148. r.Timeout = v
  149. }
  150. }
  151. // WithPretty makes the response body pretty-printed.
  152. func (f ClusterStats) WithPretty() func(*ClusterStatsRequest) {
  153. return func(r *ClusterStatsRequest) {
  154. r.Pretty = true
  155. }
  156. }
  157. // WithHuman makes statistical values human-readable.
  158. func (f ClusterStats) WithHuman() func(*ClusterStatsRequest) {
  159. return func(r *ClusterStatsRequest) {
  160. r.Human = true
  161. }
  162. }
  163. // WithErrorTrace includes the stack trace for errors in the response body.
  164. func (f ClusterStats) WithErrorTrace() func(*ClusterStatsRequest) {
  165. return func(r *ClusterStatsRequest) {
  166. r.ErrorTrace = true
  167. }
  168. }
  169. // WithFilterPath filters the properties of the response body.
  170. func (f ClusterStats) WithFilterPath(v ...string) func(*ClusterStatsRequest) {
  171. return func(r *ClusterStatsRequest) {
  172. r.FilterPath = v
  173. }
  174. }
  175. // WithHeader adds the headers to the HTTP request.
  176. func (f ClusterStats) WithHeader(h map[string]string) func(*ClusterStatsRequest) {
  177. return func(r *ClusterStatsRequest) {
  178. if r.Header == nil {
  179. r.Header = make(http.Header)
  180. }
  181. for k, v := range h {
  182. r.Header.Add(k, v)
  183. }
  184. }
  185. }
  186. // WithOpaqueID adds the X-Opaque-Id header to the HTTP request.
  187. func (f ClusterStats) WithOpaqueID(s string) func(*ClusterStatsRequest) {
  188. return func(r *ClusterStatsRequest) {
  189. if r.Header == nil {
  190. r.Header = make(http.Header)
  191. }
  192. r.Header.Set("X-Opaque-Id", s)
  193. }
  194. }