api.indices.disk_usage.go 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255
  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. )
  26. func newIndicesDiskUsageFunc(t Transport) IndicesDiskUsage {
  27. return func(index string, o ...func(*IndicesDiskUsageRequest)) (*Response, error) {
  28. var r = IndicesDiskUsageRequest{Index: index}
  29. for _, f := range o {
  30. f(&r)
  31. }
  32. return r.Do(r.ctx, t)
  33. }
  34. }
  35. // ----- API Definition -------------------------------------------------------
  36. // IndicesDiskUsage analyzes the disk usage of each field of an index or data stream
  37. //
  38. // This API is experimental.
  39. //
  40. // See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-disk-usage.html.
  41. type IndicesDiskUsage func(index string, o ...func(*IndicesDiskUsageRequest)) (*Response, error)
  42. // IndicesDiskUsageRequest configures the Indices Disk Usage API request.
  43. type IndicesDiskUsageRequest struct {
  44. Index string
  45. AllowNoIndices *bool
  46. ExpandWildcards string
  47. Flush *bool
  48. IgnoreUnavailable *bool
  49. RunExpensiveTasks *bool
  50. Pretty bool
  51. Human bool
  52. ErrorTrace bool
  53. FilterPath []string
  54. Header http.Header
  55. ctx context.Context
  56. }
  57. // Do executes the request and returns response or error.
  58. func (r IndicesDiskUsageRequest) Do(ctx context.Context, transport Transport) (*Response, error) {
  59. var (
  60. method string
  61. path strings.Builder
  62. params map[string]string
  63. )
  64. method = "POST"
  65. path.Grow(1 + len(r.Index) + 1 + len("_disk_usage"))
  66. path.WriteString("/")
  67. path.WriteString(r.Index)
  68. path.WriteString("/")
  69. path.WriteString("_disk_usage")
  70. params = make(map[string]string)
  71. if r.AllowNoIndices != nil {
  72. params["allow_no_indices"] = strconv.FormatBool(*r.AllowNoIndices)
  73. }
  74. if r.ExpandWildcards != "" {
  75. params["expand_wildcards"] = r.ExpandWildcards
  76. }
  77. if r.Flush != nil {
  78. params["flush"] = strconv.FormatBool(*r.Flush)
  79. }
  80. if r.IgnoreUnavailable != nil {
  81. params["ignore_unavailable"] = strconv.FormatBool(*r.IgnoreUnavailable)
  82. }
  83. if r.RunExpensiveTasks != nil {
  84. params["run_expensive_tasks"] = strconv.FormatBool(*r.RunExpensiveTasks)
  85. }
  86. if r.Pretty {
  87. params["pretty"] = "true"
  88. }
  89. if r.Human {
  90. params["human"] = "true"
  91. }
  92. if r.ErrorTrace {
  93. params["error_trace"] = "true"
  94. }
  95. if len(r.FilterPath) > 0 {
  96. params["filter_path"] = strings.Join(r.FilterPath, ",")
  97. }
  98. req, err := newRequest(method, path.String(), nil)
  99. if err != nil {
  100. return nil, err
  101. }
  102. if len(params) > 0 {
  103. q := req.URL.Query()
  104. for k, v := range params {
  105. q.Set(k, v)
  106. }
  107. req.URL.RawQuery = q.Encode()
  108. }
  109. if len(r.Header) > 0 {
  110. if len(req.Header) == 0 {
  111. req.Header = r.Header
  112. } else {
  113. for k, vv := range r.Header {
  114. for _, v := range vv {
  115. req.Header.Add(k, v)
  116. }
  117. }
  118. }
  119. }
  120. if ctx != nil {
  121. req = req.WithContext(ctx)
  122. }
  123. res, err := transport.Perform(req)
  124. if err != nil {
  125. return nil, err
  126. }
  127. response := Response{
  128. StatusCode: res.StatusCode,
  129. Body: res.Body,
  130. Header: res.Header,
  131. }
  132. return &response, nil
  133. }
  134. // WithContext sets the request context.
  135. func (f IndicesDiskUsage) WithContext(v context.Context) func(*IndicesDiskUsageRequest) {
  136. return func(r *IndicesDiskUsageRequest) {
  137. r.ctx = v
  138. }
  139. }
  140. // WithAllowNoIndices - whether to ignore if a wildcard indices expression resolves into no concrete indices. (this includes `_all` string or when no indices have been specified).
  141. func (f IndicesDiskUsage) WithAllowNoIndices(v bool) func(*IndicesDiskUsageRequest) {
  142. return func(r *IndicesDiskUsageRequest) {
  143. r.AllowNoIndices = &v
  144. }
  145. }
  146. // WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
  147. func (f IndicesDiskUsage) WithExpandWildcards(v string) func(*IndicesDiskUsageRequest) {
  148. return func(r *IndicesDiskUsageRequest) {
  149. r.ExpandWildcards = v
  150. }
  151. }
  152. // WithFlush - whether flush or not before analyzing the index disk usage. defaults to true.
  153. func (f IndicesDiskUsage) WithFlush(v bool) func(*IndicesDiskUsageRequest) {
  154. return func(r *IndicesDiskUsageRequest) {
  155. r.Flush = &v
  156. }
  157. }
  158. // WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
  159. func (f IndicesDiskUsage) WithIgnoreUnavailable(v bool) func(*IndicesDiskUsageRequest) {
  160. return func(r *IndicesDiskUsageRequest) {
  161. r.IgnoreUnavailable = &v
  162. }
  163. }
  164. // WithRunExpensiveTasks - must be set to [true] in order for the task to be performed. defaults to false..
  165. func (f IndicesDiskUsage) WithRunExpensiveTasks(v bool) func(*IndicesDiskUsageRequest) {
  166. return func(r *IndicesDiskUsageRequest) {
  167. r.RunExpensiveTasks = &v
  168. }
  169. }
  170. // WithPretty makes the response body pretty-printed.
  171. func (f IndicesDiskUsage) WithPretty() func(*IndicesDiskUsageRequest) {
  172. return func(r *IndicesDiskUsageRequest) {
  173. r.Pretty = true
  174. }
  175. }
  176. // WithHuman makes statistical values human-readable.
  177. func (f IndicesDiskUsage) WithHuman() func(*IndicesDiskUsageRequest) {
  178. return func(r *IndicesDiskUsageRequest) {
  179. r.Human = true
  180. }
  181. }
  182. // WithErrorTrace includes the stack trace for errors in the response body.
  183. func (f IndicesDiskUsage) WithErrorTrace() func(*IndicesDiskUsageRequest) {
  184. return func(r *IndicesDiskUsageRequest) {
  185. r.ErrorTrace = true
  186. }
  187. }
  188. // WithFilterPath filters the properties of the response body.
  189. func (f IndicesDiskUsage) WithFilterPath(v ...string) func(*IndicesDiskUsageRequest) {
  190. return func(r *IndicesDiskUsageRequest) {
  191. r.FilterPath = v
  192. }
  193. }
  194. // WithHeader adds the headers to the HTTP request.
  195. func (f IndicesDiskUsage) WithHeader(h map[string]string) func(*IndicesDiskUsageRequest) {
  196. return func(r *IndicesDiskUsageRequest) {
  197. if r.Header == nil {
  198. r.Header = make(http.Header)
  199. }
  200. for k, v := range h {
  201. r.Header.Add(k, v)
  202. }
  203. }
  204. }
  205. // WithOpaqueID adds the X-Opaque-Id header to the HTTP request.
  206. func (f IndicesDiskUsage) WithOpaqueID(s string) func(*IndicesDiskUsageRequest) {
  207. return func(r *IndicesDiskUsageRequest) {
  208. if r.Header == nil {
  209. r.Header = make(http.Header)
  210. }
  211. r.Header.Set("X-Opaque-Id", s)
  212. }
  213. }