api.indices.forcemerge.go 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274
  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 newIndicesForcemergeFunc(t Transport) IndicesForcemerge {
  27. return func(o ...func(*IndicesForcemergeRequest)) (*Response, error) {
  28. var r = IndicesForcemergeRequest{}
  29. for _, f := range o {
  30. f(&r)
  31. }
  32. return r.Do(r.ctx, t)
  33. }
  34. }
  35. // ----- API Definition -------------------------------------------------------
  36. // IndicesForcemerge performs the force merge operation on one or more indices.
  37. //
  38. // See full documentation at https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-forcemerge.html.
  39. type IndicesForcemerge func(o ...func(*IndicesForcemergeRequest)) (*Response, error)
  40. // IndicesForcemergeRequest configures the Indices Forcemerge API request.
  41. type IndicesForcemergeRequest struct {
  42. Index []string
  43. AllowNoIndices *bool
  44. ExpandWildcards string
  45. Flush *bool
  46. IgnoreUnavailable *bool
  47. MaxNumSegments *int
  48. OnlyExpungeDeletes *bool
  49. Pretty bool
  50. Human bool
  51. ErrorTrace bool
  52. FilterPath []string
  53. Header http.Header
  54. ctx context.Context
  55. }
  56. // Do executes the request and returns response or error.
  57. func (r IndicesForcemergeRequest) Do(ctx context.Context, transport Transport) (*Response, error) {
  58. var (
  59. method string
  60. path strings.Builder
  61. params map[string]string
  62. )
  63. method = "POST"
  64. path.Grow(1 + len(strings.Join(r.Index, ",")) + 1 + len("_forcemerge"))
  65. if len(r.Index) > 0 {
  66. path.WriteString("/")
  67. path.WriteString(strings.Join(r.Index, ","))
  68. }
  69. path.WriteString("/")
  70. path.WriteString("_forcemerge")
  71. params = make(map[string]string)
  72. if r.AllowNoIndices != nil {
  73. params["allow_no_indices"] = strconv.FormatBool(*r.AllowNoIndices)
  74. }
  75. if r.ExpandWildcards != "" {
  76. params["expand_wildcards"] = r.ExpandWildcards
  77. }
  78. if r.Flush != nil {
  79. params["flush"] = strconv.FormatBool(*r.Flush)
  80. }
  81. if r.IgnoreUnavailable != nil {
  82. params["ignore_unavailable"] = strconv.FormatBool(*r.IgnoreUnavailable)
  83. }
  84. if r.MaxNumSegments != nil {
  85. params["max_num_segments"] = strconv.FormatInt(int64(*r.MaxNumSegments), 10)
  86. }
  87. if r.OnlyExpungeDeletes != nil {
  88. params["only_expunge_deletes"] = strconv.FormatBool(*r.OnlyExpungeDeletes)
  89. }
  90. if r.Pretty {
  91. params["pretty"] = "true"
  92. }
  93. if r.Human {
  94. params["human"] = "true"
  95. }
  96. if r.ErrorTrace {
  97. params["error_trace"] = "true"
  98. }
  99. if len(r.FilterPath) > 0 {
  100. params["filter_path"] = strings.Join(r.FilterPath, ",")
  101. }
  102. req, err := newRequest(method, path.String(), nil)
  103. if err != nil {
  104. return nil, err
  105. }
  106. if len(params) > 0 {
  107. q := req.URL.Query()
  108. for k, v := range params {
  109. q.Set(k, v)
  110. }
  111. req.URL.RawQuery = q.Encode()
  112. }
  113. if len(r.Header) > 0 {
  114. if len(req.Header) == 0 {
  115. req.Header = r.Header
  116. } else {
  117. for k, vv := range r.Header {
  118. for _, v := range vv {
  119. req.Header.Add(k, v)
  120. }
  121. }
  122. }
  123. }
  124. if ctx != nil {
  125. req = req.WithContext(ctx)
  126. }
  127. res, err := transport.Perform(req)
  128. if err != nil {
  129. return nil, err
  130. }
  131. response := Response{
  132. StatusCode: res.StatusCode,
  133. Body: res.Body,
  134. Header: res.Header,
  135. }
  136. return &response, nil
  137. }
  138. // WithContext sets the request context.
  139. func (f IndicesForcemerge) WithContext(v context.Context) func(*IndicesForcemergeRequest) {
  140. return func(r *IndicesForcemergeRequest) {
  141. r.ctx = v
  142. }
  143. }
  144. // WithIndex - a list of index names; use _all to perform the operation on all indices.
  145. func (f IndicesForcemerge) WithIndex(v ...string) func(*IndicesForcemergeRequest) {
  146. return func(r *IndicesForcemergeRequest) {
  147. r.Index = v
  148. }
  149. }
  150. // 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).
  151. func (f IndicesForcemerge) WithAllowNoIndices(v bool) func(*IndicesForcemergeRequest) {
  152. return func(r *IndicesForcemergeRequest) {
  153. r.AllowNoIndices = &v
  154. }
  155. }
  156. // WithExpandWildcards - whether to expand wildcard expression to concrete indices that are open, closed or both..
  157. func (f IndicesForcemerge) WithExpandWildcards(v string) func(*IndicesForcemergeRequest) {
  158. return func(r *IndicesForcemergeRequest) {
  159. r.ExpandWildcards = v
  160. }
  161. }
  162. // WithFlush - specify whether the index should be flushed after performing the operation (default: true).
  163. func (f IndicesForcemerge) WithFlush(v bool) func(*IndicesForcemergeRequest) {
  164. return func(r *IndicesForcemergeRequest) {
  165. r.Flush = &v
  166. }
  167. }
  168. // WithIgnoreUnavailable - whether specified concrete indices should be ignored when unavailable (missing or closed).
  169. func (f IndicesForcemerge) WithIgnoreUnavailable(v bool) func(*IndicesForcemergeRequest) {
  170. return func(r *IndicesForcemergeRequest) {
  171. r.IgnoreUnavailable = &v
  172. }
  173. }
  174. // WithMaxNumSegments - the number of segments the index should be merged into (default: dynamic).
  175. func (f IndicesForcemerge) WithMaxNumSegments(v int) func(*IndicesForcemergeRequest) {
  176. return func(r *IndicesForcemergeRequest) {
  177. r.MaxNumSegments = &v
  178. }
  179. }
  180. // WithOnlyExpungeDeletes - specify whether the operation should only expunge deleted documents.
  181. func (f IndicesForcemerge) WithOnlyExpungeDeletes(v bool) func(*IndicesForcemergeRequest) {
  182. return func(r *IndicesForcemergeRequest) {
  183. r.OnlyExpungeDeletes = &v
  184. }
  185. }
  186. // WithPretty makes the response body pretty-printed.
  187. func (f IndicesForcemerge) WithPretty() func(*IndicesForcemergeRequest) {
  188. return func(r *IndicesForcemergeRequest) {
  189. r.Pretty = true
  190. }
  191. }
  192. // WithHuman makes statistical values human-readable.
  193. func (f IndicesForcemerge) WithHuman() func(*IndicesForcemergeRequest) {
  194. return func(r *IndicesForcemergeRequest) {
  195. r.Human = true
  196. }
  197. }
  198. // WithErrorTrace includes the stack trace for errors in the response body.
  199. func (f IndicesForcemerge) WithErrorTrace() func(*IndicesForcemergeRequest) {
  200. return func(r *IndicesForcemergeRequest) {
  201. r.ErrorTrace = true
  202. }
  203. }
  204. // WithFilterPath filters the properties of the response body.
  205. func (f IndicesForcemerge) WithFilterPath(v ...string) func(*IndicesForcemergeRequest) {
  206. return func(r *IndicesForcemergeRequest) {
  207. r.FilterPath = v
  208. }
  209. }
  210. // WithHeader adds the headers to the HTTP request.
  211. func (f IndicesForcemerge) WithHeader(h map[string]string) func(*IndicesForcemergeRequest) {
  212. return func(r *IndicesForcemergeRequest) {
  213. if r.Header == nil {
  214. r.Header = make(http.Header)
  215. }
  216. for k, v := range h {
  217. r.Header.Add(k, v)
  218. }
  219. }
  220. }
  221. // WithOpaqueID adds the X-Opaque-Id header to the HTTP request.
  222. func (f IndicesForcemerge) WithOpaqueID(s string) func(*IndicesForcemergeRequest) {
  223. return func(r *IndicesForcemergeRequest) {
  224. if r.Header == nil {
  225. r.Header = make(http.Header)
  226. }
  227. r.Header.Set("X-Opaque-Id", s)
  228. }
  229. }