-
Notifications
You must be signed in to change notification settings - Fork 98
/
api.snapshot.get.go
293 lines (248 loc) · 7.27 KB
/
api.snapshot.get.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
// SPDX-License-Identifier: Apache-2.0
//
// The OpenSearch Contributors require contributions made to
// this file be licensed under the Apache-2.0 license or a
// compatible open source license.
//
// Modifications Copyright OpenSearch Contributors. See
// GitHub history for details.
// Licensed to Elasticsearch B.V. under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Elasticsearch B.V. licenses this file to you under
// the Apache License, Version 2.0 (the "License"); you may
// not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
package opensearchapi
import (
"context"
"net/http"
"strconv"
"strings"
"time"
)
func newSnapshotGetFunc(t Transport) SnapshotGet {
return func(repository string, snapshot []string, o ...func(*SnapshotGetRequest)) (*Response, error) {
var r = SnapshotGetRequest{Repository: repository, Snapshot: snapshot}
for _, f := range o {
f(&r)
}
return r.Do(r.ctx, t)
}
}
// ----- API Definition -------------------------------------------------------
// SnapshotGet returns information about a snapshot.
//
//
type SnapshotGet func(repository string, snapshot []string, o ...func(*SnapshotGetRequest)) (*Response, error)
// SnapshotGetRequest configures the Snapshot Get API request.
//
type SnapshotGetRequest struct {
Repository string
Snapshot []string
IgnoreUnavailable *bool
IncludeRepository *bool
IndexDetails *bool
MasterTimeout time.Duration
ClusterManagerTimeout time.Duration
Verbose *bool
Pretty bool
Human bool
ErrorTrace bool
FilterPath []string
Header http.Header
ctx context.Context
}
// Do executes the request and returns response or error.
//
func (r SnapshotGetRequest) Do(ctx context.Context, transport Transport) (*Response, error) {
var (
method string
path strings.Builder
params map[string]string
)
method = "GET"
path.Grow(1 + len("_snapshot") + 1 + len(r.Repository) + 1 + len(strings.Join(r.Snapshot, ",")))
path.WriteString("/")
path.WriteString("_snapshot")
path.WriteString("/")
path.WriteString(r.Repository)
path.WriteString("/")
path.WriteString(strings.Join(r.Snapshot, ","))
params = make(map[string]string)
if r.IgnoreUnavailable != nil {
params["ignore_unavailable"] = strconv.FormatBool(*r.IgnoreUnavailable)
}
if r.IncludeRepository != nil {
params["include_repository"] = strconv.FormatBool(*r.IncludeRepository)
}
if r.IndexDetails != nil {
params["index_details"] = strconv.FormatBool(*r.IndexDetails)
}
if r.MasterTimeout != 0 {
params["master_timeout"] = formatDuration(r.MasterTimeout)
}
if r.ClusterManagerTimeout != 0 {
params["cluster_manager_timeout"] = formatDuration(r.ClusterManagerTimeout)
}
if r.Verbose != nil {
params["verbose"] = strconv.FormatBool(*r.Verbose)
}
if r.Pretty {
params["pretty"] = "true"
}
if r.Human {
params["human"] = "true"
}
if r.ErrorTrace {
params["error_trace"] = "true"
}
if len(r.FilterPath) > 0 {
params["filter_path"] = strings.Join(r.FilterPath, ",")
}
req, err := newRequest(method, path.String(), nil)
if err != nil {
return nil, err
}
if len(params) > 0 {
q := req.URL.Query()
for k, v := range params {
q.Set(k, v)
}
req.URL.RawQuery = q.Encode()
}
if len(r.Header) > 0 {
if len(req.Header) == 0 {
req.Header = r.Header
} else {
for k, vv := range r.Header {
for _, v := range vv {
req.Header.Add(k, v)
}
}
}
}
if ctx != nil {
req = req.WithContext(ctx)
}
res, err := transport.Perform(req)
if err != nil {
return nil, err
}
response := Response{
StatusCode: res.StatusCode,
Body: res.Body,
Header: res.Header,
}
return &response, nil
}
// WithContext sets the request context.
//
func (f SnapshotGet) WithContext(v context.Context) func(*SnapshotGetRequest) {
return func(r *SnapshotGetRequest) {
r.ctx = v
}
}
// WithIgnoreUnavailable - whether to ignore unavailable snapshots, defaults to false which means a snapshotmissingexception is thrown.
//
func (f SnapshotGet) WithIgnoreUnavailable(v bool) func(*SnapshotGetRequest) {
return func(r *SnapshotGetRequest) {
r.IgnoreUnavailable = &v
}
}
// WithIncludeRepository - whether to include the repository name in the snapshot info. defaults to true..
//
func (f SnapshotGet) WithIncludeRepository(v bool) func(*SnapshotGetRequest) {
return func(r *SnapshotGetRequest) {
r.IncludeRepository = &v
}
}
// WithIndexDetails - whether to include details of each index in the snapshot, if those details are available. defaults to false..
//
func (f SnapshotGet) WithIndexDetails(v bool) func(*SnapshotGetRequest) {
return func(r *SnapshotGetRequest) {
r.IndexDetails = &v
}
}
// WithMasterTimeout - explicit operation timeout for connection to cluster-manager node.
//
// Deprecated: To promote inclusive language, use WithClusterManagerTimeout instead.
//
func (f SnapshotGet) WithMasterTimeout(v time.Duration) func(*SnapshotGetRequest) {
return func(r *SnapshotGetRequest) {
r.MasterTimeout = v
}
}
// WithClusterManagerTimeout - explicit operation timeout for connection to cluster-manager node.
//
func (f SnapshotGet) WithClusterManagerTimeout(v time.Duration) func(*SnapshotGetRequest) {
return func(r *SnapshotGetRequest) {
r.ClusterManagerTimeout = v
}
}
// WithVerbose - whether to show verbose snapshot info or only show the basic info found in the repository index blob.
//
func (f SnapshotGet) WithVerbose(v bool) func(*SnapshotGetRequest) {
return func(r *SnapshotGetRequest) {
r.Verbose = &v
}
}
// WithPretty makes the response body pretty-printed.
//
func (f SnapshotGet) WithPretty() func(*SnapshotGetRequest) {
return func(r *SnapshotGetRequest) {
r.Pretty = true
}
}
// WithHuman makes statistical values human-readable.
//
func (f SnapshotGet) WithHuman() func(*SnapshotGetRequest) {
return func(r *SnapshotGetRequest) {
r.Human = true
}
}
// WithErrorTrace includes the stack trace for errors in the response body.
//
func (f SnapshotGet) WithErrorTrace() func(*SnapshotGetRequest) {
return func(r *SnapshotGetRequest) {
r.ErrorTrace = true
}
}
// WithFilterPath filters the properties of the response body.
//
func (f SnapshotGet) WithFilterPath(v ...string) func(*SnapshotGetRequest) {
return func(r *SnapshotGetRequest) {
r.FilterPath = v
}
}
// WithHeader adds the headers to the HTTP request.
//
func (f SnapshotGet) WithHeader(h map[string]string) func(*SnapshotGetRequest) {
return func(r *SnapshotGetRequest) {
if r.Header == nil {
r.Header = make(http.Header)
}
for k, v := range h {
r.Header.Add(k, v)
}
}
}
// WithOpaqueID adds the X-Opaque-Id header to the HTTP request.
//
func (f SnapshotGet) WithOpaqueID(s string) func(*SnapshotGetRequest) {
return func(r *SnapshotGetRequest) {
if r.Header == nil {
r.Header = make(http.Header)
}
r.Header.Set("X-Opaque-Id", s)
}
}