api.xpack.ccr.follow_stats.go 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198
  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. "errors"
  23. "net/http"
  24. "strings"
  25. )
  26. func newCCRFollowStatsFunc(t Transport) CCRFollowStats {
  27. return func(index []string, o ...func(*CCRFollowStatsRequest)) (*Response, error) {
  28. var r = CCRFollowStatsRequest{Index: index}
  29. for _, f := range o {
  30. f(&r)
  31. }
  32. return r.Do(r.ctx, t)
  33. }
  34. }
  35. // ----- API Definition -------------------------------------------------------
  36. // CCRFollowStats - Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices.
  37. //
  38. // See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-stats.html.
  39. type CCRFollowStats func(index []string, o ...func(*CCRFollowStatsRequest)) (*Response, error)
  40. // CCRFollowStatsRequest configures the CCR Follow Stats API request.
  41. type CCRFollowStatsRequest struct {
  42. Index []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 CCRFollowStatsRequest) 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. if len(r.Index) == 0 {
  59. return nil, errors.New("index is required and cannot be nil or empty")
  60. }
  61. path.Grow(1 + len(strings.Join(r.Index, ",")) + 1 + len("_ccr") + 1 + len("stats"))
  62. path.WriteString("/")
  63. path.WriteString(strings.Join(r.Index, ","))
  64. path.WriteString("/")
  65. path.WriteString("_ccr")
  66. path.WriteString("/")
  67. path.WriteString("stats")
  68. params = make(map[string]string)
  69. if r.Pretty {
  70. params["pretty"] = "true"
  71. }
  72. if r.Human {
  73. params["human"] = "true"
  74. }
  75. if r.ErrorTrace {
  76. params["error_trace"] = "true"
  77. }
  78. if len(r.FilterPath) > 0 {
  79. params["filter_path"] = strings.Join(r.FilterPath, ",")
  80. }
  81. req, err := newRequest(method, path.String(), nil)
  82. if err != nil {
  83. return nil, err
  84. }
  85. if len(params) > 0 {
  86. q := req.URL.Query()
  87. for k, v := range params {
  88. q.Set(k, v)
  89. }
  90. req.URL.RawQuery = q.Encode()
  91. }
  92. if len(r.Header) > 0 {
  93. if len(req.Header) == 0 {
  94. req.Header = r.Header
  95. } else {
  96. for k, vv := range r.Header {
  97. for _, v := range vv {
  98. req.Header.Add(k, v)
  99. }
  100. }
  101. }
  102. }
  103. if ctx != nil {
  104. req = req.WithContext(ctx)
  105. }
  106. res, err := transport.Perform(req)
  107. if err != nil {
  108. return nil, err
  109. }
  110. response := Response{
  111. StatusCode: res.StatusCode,
  112. Body: res.Body,
  113. Header: res.Header,
  114. }
  115. return &response, nil
  116. }
  117. // WithContext sets the request context.
  118. func (f CCRFollowStats) WithContext(v context.Context) func(*CCRFollowStatsRequest) {
  119. return func(r *CCRFollowStatsRequest) {
  120. r.ctx = v
  121. }
  122. }
  123. // WithPretty makes the response body pretty-printed.
  124. func (f CCRFollowStats) WithPretty() func(*CCRFollowStatsRequest) {
  125. return func(r *CCRFollowStatsRequest) {
  126. r.Pretty = true
  127. }
  128. }
  129. // WithHuman makes statistical values human-readable.
  130. func (f CCRFollowStats) WithHuman() func(*CCRFollowStatsRequest) {
  131. return func(r *CCRFollowStatsRequest) {
  132. r.Human = true
  133. }
  134. }
  135. // WithErrorTrace includes the stack trace for errors in the response body.
  136. func (f CCRFollowStats) WithErrorTrace() func(*CCRFollowStatsRequest) {
  137. return func(r *CCRFollowStatsRequest) {
  138. r.ErrorTrace = true
  139. }
  140. }
  141. // WithFilterPath filters the properties of the response body.
  142. func (f CCRFollowStats) WithFilterPath(v ...string) func(*CCRFollowStatsRequest) {
  143. return func(r *CCRFollowStatsRequest) {
  144. r.FilterPath = v
  145. }
  146. }
  147. // WithHeader adds the headers to the HTTP request.
  148. func (f CCRFollowStats) WithHeader(h map[string]string) func(*CCRFollowStatsRequest) {
  149. return func(r *CCRFollowStatsRequest) {
  150. if r.Header == nil {
  151. r.Header = make(http.Header)
  152. }
  153. for k, v := range h {
  154. r.Header.Add(k, v)
  155. }
  156. }
  157. }
  158. // WithOpaqueID adds the X-Opaque-Id header to the HTTP request.
  159. func (f CCRFollowStats) WithOpaqueID(s string) func(*CCRFollowStatsRequest) {
  160. return func(r *CCRFollowStatsRequest) {
  161. if r.Header == nil {
  162. r.Header = make(http.Header)
  163. }
  164. r.Header.Set("X-Opaque-Id", s)
  165. }
  166. }