api.indices.resolve_index.go 5.4 KB

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