api.xpack.searchable_snapshots.stats.go 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215
  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. "strings"
  24. )
  25. func newSearchableSnapshotsStatsFunc(t Transport) SearchableSnapshotsStats {
  26. return func(o ...func(*SearchableSnapshotsStatsRequest)) (*Response, error) {
  27. var r = SearchableSnapshotsStatsRequest{}
  28. for _, f := range o {
  29. f(&r)
  30. }
  31. return r.Do(r.ctx, t)
  32. }
  33. }
  34. // ----- API Definition -------------------------------------------------------
  35. // SearchableSnapshotsStats - Retrieve shard-level statistics about searchable snapshots.
  36. //
  37. // See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html.
  38. type SearchableSnapshotsStats func(o ...func(*SearchableSnapshotsStatsRequest)) (*Response, error)
  39. // SearchableSnapshotsStatsRequest configures the Searchable Snapshots Stats API request.
  40. type SearchableSnapshotsStatsRequest struct {
  41. Index []string
  42. Level string
  43. Pretty bool
  44. Human bool
  45. ErrorTrace bool
  46. FilterPath []string
  47. Header http.Header
  48. ctx context.Context
  49. }
  50. // Do executes the request and returns response or error.
  51. func (r SearchableSnapshotsStatsRequest) Do(ctx context.Context, transport Transport) (*Response, error) {
  52. var (
  53. method string
  54. path strings.Builder
  55. params map[string]string
  56. )
  57. method = "GET"
  58. path.Grow(1 + len(strings.Join(r.Index, ",")) + 1 + len("_searchable_snapshots") + 1 + len("stats"))
  59. if len(r.Index) > 0 {
  60. path.WriteString("/")
  61. path.WriteString(strings.Join(r.Index, ","))
  62. }
  63. path.WriteString("/")
  64. path.WriteString("_searchable_snapshots")
  65. path.WriteString("/")
  66. path.WriteString("stats")
  67. params = make(map[string]string)
  68. if r.Level != "" {
  69. params["level"] = r.Level
  70. }
  71. if r.Pretty {
  72. params["pretty"] = "true"
  73. }
  74. if r.Human {
  75. params["human"] = "true"
  76. }
  77. if r.ErrorTrace {
  78. params["error_trace"] = "true"
  79. }
  80. if len(r.FilterPath) > 0 {
  81. params["filter_path"] = strings.Join(r.FilterPath, ",")
  82. }
  83. req, err := newRequest(method, path.String(), nil)
  84. if err != nil {
  85. return nil, err
  86. }
  87. if len(params) > 0 {
  88. q := req.URL.Query()
  89. for k, v := range params {
  90. q.Set(k, v)
  91. }
  92. req.URL.RawQuery = q.Encode()
  93. }
  94. if len(r.Header) > 0 {
  95. if len(req.Header) == 0 {
  96. req.Header = r.Header
  97. } else {
  98. for k, vv := range r.Header {
  99. for _, v := range vv {
  100. req.Header.Add(k, v)
  101. }
  102. }
  103. }
  104. }
  105. if ctx != nil {
  106. req = req.WithContext(ctx)
  107. }
  108. res, err := transport.Perform(req)
  109. if err != nil {
  110. return nil, err
  111. }
  112. response := Response{
  113. StatusCode: res.StatusCode,
  114. Body: res.Body,
  115. Header: res.Header,
  116. }
  117. return &response, nil
  118. }
  119. // WithContext sets the request context.
  120. func (f SearchableSnapshotsStats) WithContext(v context.Context) func(*SearchableSnapshotsStatsRequest) {
  121. return func(r *SearchableSnapshotsStatsRequest) {
  122. r.ctx = v
  123. }
  124. }
  125. // WithIndex - a list of index names.
  126. func (f SearchableSnapshotsStats) WithIndex(v ...string) func(*SearchableSnapshotsStatsRequest) {
  127. return func(r *SearchableSnapshotsStatsRequest) {
  128. r.Index = v
  129. }
  130. }
  131. // WithLevel - return stats aggregated at cluster, index or shard level.
  132. func (f SearchableSnapshotsStats) WithLevel(v string) func(*SearchableSnapshotsStatsRequest) {
  133. return func(r *SearchableSnapshotsStatsRequest) {
  134. r.Level = v
  135. }
  136. }
  137. // WithPretty makes the response body pretty-printed.
  138. func (f SearchableSnapshotsStats) WithPretty() func(*SearchableSnapshotsStatsRequest) {
  139. return func(r *SearchableSnapshotsStatsRequest) {
  140. r.Pretty = true
  141. }
  142. }
  143. // WithHuman makes statistical values human-readable.
  144. func (f SearchableSnapshotsStats) WithHuman() func(*SearchableSnapshotsStatsRequest) {
  145. return func(r *SearchableSnapshotsStatsRequest) {
  146. r.Human = true
  147. }
  148. }
  149. // WithErrorTrace includes the stack trace for errors in the response body.
  150. func (f SearchableSnapshotsStats) WithErrorTrace() func(*SearchableSnapshotsStatsRequest) {
  151. return func(r *SearchableSnapshotsStatsRequest) {
  152. r.ErrorTrace = true
  153. }
  154. }
  155. // WithFilterPath filters the properties of the response body.
  156. func (f SearchableSnapshotsStats) WithFilterPath(v ...string) func(*SearchableSnapshotsStatsRequest) {
  157. return func(r *SearchableSnapshotsStatsRequest) {
  158. r.FilterPath = v
  159. }
  160. }
  161. // WithHeader adds the headers to the HTTP request.
  162. func (f SearchableSnapshotsStats) WithHeader(h map[string]string) func(*SearchableSnapshotsStatsRequest) {
  163. return func(r *SearchableSnapshotsStatsRequest) {
  164. if r.Header == nil {
  165. r.Header = make(http.Header)
  166. }
  167. for k, v := range h {
  168. r.Header.Add(k, v)
  169. }
  170. }
  171. }
  172. // WithOpaqueID adds the X-Opaque-Id header to the HTTP request.
  173. func (f SearchableSnapshotsStats) WithOpaqueID(s string) func(*SearchableSnapshotsStatsRequest) {
  174. return func(r *SearchableSnapshotsStatsRequest) {
  175. if r.Header == nil {
  176. r.Header = make(http.Header)
  177. }
  178. r.Header.Set("X-Opaque-Id", s)
  179. }
  180. }