api.cluster.pending_tasks.go 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214
  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 newClusterPendingTasksFunc(t Transport) ClusterPendingTasks {
  28. return func(o ...func(*ClusterPendingTasksRequest)) (*Response, error) {
  29. var r = ClusterPendingTasksRequest{}
  30. for _, f := range o {
  31. f(&r)
  32. }
  33. return r.Do(r.ctx, t)
  34. }
  35. }
  36. // ----- API Definition -------------------------------------------------------
  37. // ClusterPendingTasks returns a list of any cluster-level changes (e.g. create index, update mapping,
  38. // allocate or fail shard) which have not yet been executed.
  39. //
  40. // See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.html.
  41. type ClusterPendingTasks func(o ...func(*ClusterPendingTasksRequest)) (*Response, error)
  42. // ClusterPendingTasksRequest configures the Cluster Pending Tasks API request.
  43. type ClusterPendingTasksRequest struct {
  44. Local *bool
  45. MasterTimeout 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 ClusterPendingTasksRequest) 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("/_cluster/pending_tasks"))
  62. path.WriteString("/_cluster/pending_tasks")
  63. params = make(map[string]string)
  64. if r.Local != nil {
  65. params["local"] = strconv.FormatBool(*r.Local)
  66. }
  67. if r.MasterTimeout != 0 {
  68. params["master_timeout"] = formatDuration(r.MasterTimeout)
  69. }
  70. if r.Pretty {
  71. params["pretty"] = "true"
  72. }
  73. if r.Human {
  74. params["human"] = "true"
  75. }
  76. if r.ErrorTrace {
  77. params["error_trace"] = "true"
  78. }
  79. if len(r.FilterPath) > 0 {
  80. params["filter_path"] = strings.Join(r.FilterPath, ",")
  81. }
  82. req, err := newRequest(method, path.String(), nil)
  83. if err != nil {
  84. return nil, err
  85. }
  86. if len(params) > 0 {
  87. q := req.URL.Query()
  88. for k, v := range params {
  89. q.Set(k, v)
  90. }
  91. req.URL.RawQuery = q.Encode()
  92. }
  93. if len(r.Header) > 0 {
  94. if len(req.Header) == 0 {
  95. req.Header = r.Header
  96. } else {
  97. for k, vv := range r.Header {
  98. for _, v := range vv {
  99. req.Header.Add(k, v)
  100. }
  101. }
  102. }
  103. }
  104. if ctx != nil {
  105. req = req.WithContext(ctx)
  106. }
  107. res, err := transport.Perform(req)
  108. if err != nil {
  109. return nil, err
  110. }
  111. response := Response{
  112. StatusCode: res.StatusCode,
  113. Body: res.Body,
  114. Header: res.Header,
  115. }
  116. return &response, nil
  117. }
  118. // WithContext sets the request context.
  119. func (f ClusterPendingTasks) WithContext(v context.Context) func(*ClusterPendingTasksRequest) {
  120. return func(r *ClusterPendingTasksRequest) {
  121. r.ctx = v
  122. }
  123. }
  124. // WithLocal - return local information, do not retrieve the state from master node (default: false).
  125. func (f ClusterPendingTasks) WithLocal(v bool) func(*ClusterPendingTasksRequest) {
  126. return func(r *ClusterPendingTasksRequest) {
  127. r.Local = &v
  128. }
  129. }
  130. // WithMasterTimeout - specify timeout for connection to master.
  131. func (f ClusterPendingTasks) WithMasterTimeout(v time.Duration) func(*ClusterPendingTasksRequest) {
  132. return func(r *ClusterPendingTasksRequest) {
  133. r.MasterTimeout = v
  134. }
  135. }
  136. // WithPretty makes the response body pretty-printed.
  137. func (f ClusterPendingTasks) WithPretty() func(*ClusterPendingTasksRequest) {
  138. return func(r *ClusterPendingTasksRequest) {
  139. r.Pretty = true
  140. }
  141. }
  142. // WithHuman makes statistical values human-readable.
  143. func (f ClusterPendingTasks) WithHuman() func(*ClusterPendingTasksRequest) {
  144. return func(r *ClusterPendingTasksRequest) {
  145. r.Human = true
  146. }
  147. }
  148. // WithErrorTrace includes the stack trace for errors in the response body.
  149. func (f ClusterPendingTasks) WithErrorTrace() func(*ClusterPendingTasksRequest) {
  150. return func(r *ClusterPendingTasksRequest) {
  151. r.ErrorTrace = true
  152. }
  153. }
  154. // WithFilterPath filters the properties of the response body.
  155. func (f ClusterPendingTasks) WithFilterPath(v ...string) func(*ClusterPendingTasksRequest) {
  156. return func(r *ClusterPendingTasksRequest) {
  157. r.FilterPath = v
  158. }
  159. }
  160. // WithHeader adds the headers to the HTTP request.
  161. func (f ClusterPendingTasks) WithHeader(h map[string]string) func(*ClusterPendingTasksRequest) {
  162. return func(r *ClusterPendingTasksRequest) {
  163. if r.Header == nil {
  164. r.Header = make(http.Header)
  165. }
  166. for k, v := range h {
  167. r.Header.Add(k, v)
  168. }
  169. }
  170. }
  171. // WithOpaqueID adds the X-Opaque-Id header to the HTTP request.
  172. func (f ClusterPendingTasks) WithOpaqueID(s string) func(*ClusterPendingTasksRequest) {
  173. return func(r *ClusterPendingTasksRequest) {
  174. if r.Header == nil {
  175. r.Header = make(http.Header)
  176. }
  177. r.Header.Set("X-Opaque-Id", s)
  178. }
  179. }