api.indices.flush_synced.go 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240
  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 newIndicesFlushSyncedFunc(t Transport) IndicesFlushSynced {
  27. return func(o ...func(*IndicesFlushSyncedRequest)) (*Response, error) {
  28. var r = IndicesFlushSyncedRequest{}
  29. for _, f := range o {
  30. f(&r)
  31. }
  32. return r.Do(r.ctx, t)
  33. }
  34. }
  35. // ----- API Definition -------------------------------------------------------
  36. // IndicesFlushSynced performs a synced flush operation on one or more indices. Synced flush is deprecated and will be removed in 8.0. Use flush instead
  37. //
  38. // See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-synced-flush-api.html.
  39. type IndicesFlushSynced func(o ...func(*IndicesFlushSyncedRequest)) (*Response, error)
  40. // IndicesFlushSyncedRequest configures the Indices Flush Synced API request.
  41. type IndicesFlushSyncedRequest struct {
  42. Index []string
  43. AllowNoIndices *bool
  44. ExpandWildcards string
  45. IgnoreUnavailable *bool
  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 IndicesFlushSyncedRequest) 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 = "POST"
  61. path.Grow(1 + len(strings.Join(r.Index, ",")) + 1 + len("_flush") + 1 + len("synced"))
  62. if len(r.Index) > 0 {
  63. path.WriteString("/")
  64. path.WriteString(strings.Join(r.Index, ","))
  65. }
  66. path.WriteString("/")
  67. path.WriteString("_flush")
  68. path.WriteString("/")
  69. path.WriteString("synced")
  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.IgnoreUnavailable != nil {
  78. params["ignore_unavailable"] = strconv.FormatBool(*r.IgnoreUnavailable)
  79. }
  80. if r.Pretty {
  81. params["pretty"] = "true"
  82. }
  83. if r.Human {
  84. params["human"] = "true"
  85. }
  86. if r.ErrorTrace {
  87. params["error_trace"] = "true"
  88. }
  89. if len(r.FilterPath) > 0 {
  90. params["filter_path"] = strings.Join(r.FilterPath, ",")
  91. }
  92. req, err := newRequest(method, path.String(), nil)
  93. if err != nil {
  94. return nil, err
  95. }
  96. if len(params) > 0 {
  97. q := req.URL.Query()
  98. for k, v := range params {
  99. q.Set(k, v)
  100. }
  101. req.URL.RawQuery = q.Encode()
  102. }
  103. if len(r.Header) > 0 {
  104. if len(req.Header) == 0 {
  105. req.Header = r.Header
  106. } else {
  107. for k, vv := range r.Header {
  108. for _, v := range vv {
  109. req.Header.Add(k, v)
  110. }
  111. }
  112. }
  113. }
  114. if ctx != nil {
  115. req = req.WithContext(ctx)
  116. }
  117. res, err := transport.Perform(req)
  118. if err != nil {
  119. return nil, err
  120. }
  121. response := Response{
  122. StatusCode: res.StatusCode,
  123. Body: res.Body,
  124. Header: res.Header,
  125. }
  126. return &response, nil
  127. }
  128. // WithContext sets the request context.
  129. func (f IndicesFlushSynced) WithContext(v context.Context) func(*IndicesFlushSyncedRequest) {
  130. return func(r *IndicesFlushSyncedRequest) {
  131. r.ctx = v
  132. }
  133. }
  134. // WithIndex - a list of index names; use _all for all indices.
  135. func (f IndicesFlushSynced) WithIndex(v ...string) func(*IndicesFlushSyncedRequest) {
  136. return func(r *IndicesFlushSyncedRequest) {
  137. r.Index = 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 IndicesFlushSynced) WithAllowNoIndices(v bool) func(*IndicesFlushSyncedRequest) {
  142. return func(r *IndicesFlushSyncedRequest) {
  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 IndicesFlushSynced) WithExpandWildcards(v string) func(*IndicesFlushSyncedRequest) {
  148. return func(r *IndicesFlushSyncedRequest) {
  149. r.ExpandWildcards = v
  150. }
  151. }
  152. // WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
  153. func (f IndicesFlushSynced) WithIgnoreUnavailable(v bool) func(*IndicesFlushSyncedRequest) {
  154. return func(r *IndicesFlushSyncedRequest) {
  155. r.IgnoreUnavailable = &v
  156. }
  157. }
  158. // WithPretty makes the response body pretty-printed.
  159. func (f IndicesFlushSynced) WithPretty() func(*IndicesFlushSyncedRequest) {
  160. return func(r *IndicesFlushSyncedRequest) {
  161. r.Pretty = true
  162. }
  163. }
  164. // WithHuman makes statistical values human-readable.
  165. func (f IndicesFlushSynced) WithHuman() func(*IndicesFlushSyncedRequest) {
  166. return func(r *IndicesFlushSyncedRequest) {
  167. r.Human = true
  168. }
  169. }
  170. // WithErrorTrace includes the stack trace for errors in the response body.
  171. func (f IndicesFlushSynced) WithErrorTrace() func(*IndicesFlushSyncedRequest) {
  172. return func(r *IndicesFlushSyncedRequest) {
  173. r.ErrorTrace = true
  174. }
  175. }
  176. // WithFilterPath filters the properties of the response body.
  177. func (f IndicesFlushSynced) WithFilterPath(v ...string) func(*IndicesFlushSyncedRequest) {
  178. return func(r *IndicesFlushSyncedRequest) {
  179. r.FilterPath = v
  180. }
  181. }
  182. // WithHeader adds the headers to the HTTP request.
  183. func (f IndicesFlushSynced) WithHeader(h map[string]string) func(*IndicesFlushSyncedRequest) {
  184. return func(r *IndicesFlushSyncedRequest) {
  185. if r.Header == nil {
  186. r.Header = make(http.Header)
  187. }
  188. for k, v := range h {
  189. r.Header.Add(k, v)
  190. }
  191. }
  192. }
  193. // WithOpaqueID adds the X-Opaque-Id header to the HTTP request.
  194. func (f IndicesFlushSynced) WithOpaqueID(s string) func(*IndicesFlushSyncedRequest) {
  195. return func(r *IndicesFlushSyncedRequest) {
  196. if r.Header == nil {
  197. r.Header = make(http.Header)
  198. }
  199. r.Header.Set("X-Opaque-Id", s)
  200. }
  201. }