/
Requests.Snapshot.cs
745 lines (642 loc) · 29.3 KB
/
Requests.Snapshot.cs
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
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
/* 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.
*/
// ███╗ ██╗ ██████╗ ████████╗██╗ ██████╗███████╗
// ████╗ ██║██╔═══██╗╚══██╔══╝██║██╔════╝██╔════╝
// ██╔██╗ ██║██║ ██║ ██║ ██║██║ █████╗
// ██║╚██╗██║██║ ██║ ██║ ██║██║ ██╔══╝
// ██║ ╚████║╚██████╔╝ ██║ ██║╚██████╗███████╗
// ╚═╝ ╚═══╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚══════╝
// -----------------------------------------------
//
// This file is automatically generated
// Please do not edit these files manually
// Run the following in the root of the repos:
//
// *NIX : ./build.sh codegen
// Windows : build.bat codegen
//
// -----------------------------------------------
// ReSharper disable RedundantUsingDirective
using System;
using System.Collections.Generic;
using System.Linq;
using System.Linq.Expressions;
using System.Runtime.Serialization;
using System.Text;
using OpenSearch.Net;
using OpenSearch.Net.Specification.SnapshotApi;
using OpenSearch.Net.Utf8Json;
// ReSharper disable RedundantBaseConstructorCall
// ReSharper disable UnusedTypeParameter
// ReSharper disable PartialMethodWithSinglePart
// ReSharper disable RedundantNameQualifier
namespace OpenSearch.Client
{
[InterfaceDataContract]
public partial interface ICleanupRepositoryRequest
: IRequest<CleanupRepositoryRequestParameters>
{
[IgnoreDataMember]
Name RepositoryName { get; }
}
/// <summary>Request for CleanupRepository <para>https://opensearch.org/docs/latest</para></summary>
public partial class CleanupRepositoryRequest
: PlainRequestBase<CleanupRepositoryRequestParameters>,
ICleanupRepositoryRequest
{
protected ICleanupRepositoryRequest Self => this;
internal override ApiUrls ApiUrls => ApiUrlsLookups.SnapshotCleanupRepository;
/// <summary>/_snapshot/{repository}/_cleanup</summary>
/// <param name="repository">this parameter is required</param>
public CleanupRepositoryRequest(Name repository)
: base(r => r.Required("repository", repository)) { }
/// <summary>Used for serialization purposes, making sure we have a parameterless constructor</summary>
[SerializationConstructor]
protected CleanupRepositoryRequest()
: base() { }
// values part of the url path
[IgnoreDataMember]
Name ICleanupRepositoryRequest.RepositoryName => Self.RouteValues.Get<Name>("repository");
// Request parameters
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
public Time ClusterManagerTimeout
{
get => Q<Time>("cluster_manager_timeout");
set => Q("cluster_manager_timeout", value);
}
/// <summary>Period to wait for a connection to the master node.</summary>
[Obsolete(
"Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead."
)]
public Time MasterTimeout
{
get => Q<Time>("master_timeout");
set => Q("master_timeout", value);
}
/// <summary>Period to wait for a response.</summary>
public Time Timeout
{
get => Q<Time>("timeout");
set => Q("timeout", value);
}
}
[InterfaceDataContract]
public partial interface ICloneSnapshotRequest : IRequest<CloneSnapshotRequestParameters>
{
[IgnoreDataMember]
Name RepositoryName { get; }
[IgnoreDataMember]
Name Snapshot { get; }
[IgnoreDataMember]
Name TargetSnapshot { get; }
}
/// <summary>Request for Clone <para>https://opensearch.org/docs/latest</para></summary>
public partial class CloneSnapshotRequest
: PlainRequestBase<CloneSnapshotRequestParameters>,
ICloneSnapshotRequest
{
protected ICloneSnapshotRequest Self => this;
internal override ApiUrls ApiUrls => ApiUrlsLookups.SnapshotClone;
/// <summary>/_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}</summary>
/// <param name="repository">this parameter is required</param>
/// <param name="snapshot">this parameter is required</param>
/// <param name="targetSnapshot">this parameter is required</param>
public CloneSnapshotRequest(Name repository, Name snapshot, Name targetSnapshot)
: base(r =>
r.Required("repository", repository)
.Required("snapshot", snapshot)
.Required("target_snapshot", targetSnapshot)
) { }
/// <summary>Used for serialization purposes, making sure we have a parameterless constructor</summary>
[SerializationConstructor]
protected CloneSnapshotRequest()
: base() { }
// values part of the url path
[IgnoreDataMember]
Name ICloneSnapshotRequest.RepositoryName => Self.RouteValues.Get<Name>("repository");
[IgnoreDataMember]
Name ICloneSnapshotRequest.Snapshot => Self.RouteValues.Get<Name>("snapshot");
[IgnoreDataMember]
Name ICloneSnapshotRequest.TargetSnapshot => Self.RouteValues.Get<Name>("target_snapshot");
// Request parameters
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
public Time ClusterManagerTimeout
{
get => Q<Time>("cluster_manager_timeout");
set => Q("cluster_manager_timeout", value);
}
/// <summary>Explicit operation timeout for connection to master node.</summary>
[Obsolete(
"Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead."
)]
public Time MasterTimeout
{
get => Q<Time>("master_timeout");
set => Q("master_timeout", value);
}
}
[InterfaceDataContract]
public partial interface ISnapshotRequest : IRequest<SnapshotRequestParameters>
{
[IgnoreDataMember]
Name RepositoryName { get; }
[IgnoreDataMember]
Name Snapshot { get; }
}
/// <summary>Request for Snapshot</summary>
public partial class SnapshotRequest
: PlainRequestBase<SnapshotRequestParameters>,
ISnapshotRequest
{
protected ISnapshotRequest Self => this;
internal override ApiUrls ApiUrls => ApiUrlsLookups.SnapshotSnapshot;
/// <summary>/_snapshot/{repository}/{snapshot}</summary>
/// <param name="repository">this parameter is required</param>
/// <param name="snapshot">this parameter is required</param>
public SnapshotRequest(Name repository, Name snapshot)
: base(r => r.Required("repository", repository).Required("snapshot", snapshot)) { }
/// <summary>Used for serialization purposes, making sure we have a parameterless constructor</summary>
[SerializationConstructor]
protected SnapshotRequest()
: base() { }
// values part of the url path
[IgnoreDataMember]
Name ISnapshotRequest.RepositoryName => Self.RouteValues.Get<Name>("repository");
[IgnoreDataMember]
Name ISnapshotRequest.Snapshot => Self.RouteValues.Get<Name>("snapshot");
// Request parameters
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
public Time ClusterManagerTimeout
{
get => Q<Time>("cluster_manager_timeout");
set => Q("cluster_manager_timeout", value);
}
/// <summary>
/// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns
/// an error.
/// </summary>
[Obsolete(
"Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead."
)]
public Time MasterTimeout
{
get => Q<Time>("master_timeout");
set => Q("master_timeout", value);
}
/// <summary>
/// If `true`, the request returns a response when the snapshot is complete. If `false`, the request returns a response when the snapshot
/// initializes.
/// </summary>
public bool? WaitForCompletion
{
get => Q<bool?>("wait_for_completion");
set => Q("wait_for_completion", value);
}
}
[InterfaceDataContract]
public partial interface ICreateRepositoryRequest : IRequest<CreateRepositoryRequestParameters>
{
[IgnoreDataMember]
Name RepositoryName { get; }
}
/// <summary>Request for CreateRepository</summary>
public partial class CreateRepositoryRequest
: PlainRequestBase<CreateRepositoryRequestParameters>,
ICreateRepositoryRequest
{
protected ICreateRepositoryRequest Self => this;
internal override ApiUrls ApiUrls => ApiUrlsLookups.SnapshotCreateRepository;
/// <summary>/_snapshot/{repository}</summary>
/// <param name="repository">this parameter is required</param>
public CreateRepositoryRequest(Name repository)
: base(r => r.Required("repository", repository)) { }
/// <summary>Used for serialization purposes, making sure we have a parameterless constructor</summary>
[SerializationConstructor]
protected CreateRepositoryRequest()
: base() { }
// values part of the url path
[IgnoreDataMember]
Name ICreateRepositoryRequest.RepositoryName => Self.RouteValues.Get<Name>("repository");
// Request parameters
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
public Time ClusterManagerTimeout
{
get => Q<Time>("cluster_manager_timeout");
set => Q("cluster_manager_timeout", value);
}
/// <summary>Explicit operation timeout for connection to master node.</summary>
[Obsolete(
"Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead."
)]
public Time MasterTimeout
{
get => Q<Time>("master_timeout");
set => Q("master_timeout", value);
}
/// <summary>Explicit operation timeout.</summary>
public Time Timeout
{
get => Q<Time>("timeout");
set => Q("timeout", value);
}
/// <summary>Whether to verify the repository after creation.</summary>
public bool? Verify
{
get => Q<bool?>("verify");
set => Q("verify", value);
}
}
[InterfaceDataContract]
public partial interface IDeleteSnapshotRequest : IRequest<DeleteSnapshotRequestParameters>
{
[IgnoreDataMember]
Name RepositoryName { get; }
[IgnoreDataMember]
Name Snapshot { get; }
}
/// <summary>Request for Delete <para>https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot/</para></summary>
public partial class DeleteSnapshotRequest
: PlainRequestBase<DeleteSnapshotRequestParameters>,
IDeleteSnapshotRequest
{
protected IDeleteSnapshotRequest Self => this;
internal override ApiUrls ApiUrls => ApiUrlsLookups.SnapshotDelete;
/// <summary>/_snapshot/{repository}/{snapshot}</summary>
/// <param name="repository">this parameter is required</param>
/// <param name="snapshot">this parameter is required</param>
public DeleteSnapshotRequest(Name repository, Name snapshot)
: base(r => r.Required("repository", repository).Required("snapshot", snapshot)) { }
/// <summary>Used for serialization purposes, making sure we have a parameterless constructor</summary>
[SerializationConstructor]
protected DeleteSnapshotRequest()
: base() { }
// values part of the url path
[IgnoreDataMember]
Name IDeleteSnapshotRequest.RepositoryName => Self.RouteValues.Get<Name>("repository");
[IgnoreDataMember]
Name IDeleteSnapshotRequest.Snapshot => Self.RouteValues.Get<Name>("snapshot");
// Request parameters
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
public Time ClusterManagerTimeout
{
get => Q<Time>("cluster_manager_timeout");
set => Q("cluster_manager_timeout", value);
}
/// <summary>Explicit operation timeout for connection to master node.</summary>
[Obsolete(
"Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead."
)]
public Time MasterTimeout
{
get => Q<Time>("master_timeout");
set => Q("master_timeout", value);
}
}
[InterfaceDataContract]
public partial interface IDeleteRepositoryRequest : IRequest<DeleteRepositoryRequestParameters>
{
[IgnoreDataMember]
Names RepositoryName { get; }
}
/// <summary>Request for DeleteRepository <para>https://opensearch.org/docs/latest/api-reference/snapshots/delete-snapshot-repository/</para></summary>
public partial class DeleteRepositoryRequest
: PlainRequestBase<DeleteRepositoryRequestParameters>,
IDeleteRepositoryRequest
{
protected IDeleteRepositoryRequest Self => this;
internal override ApiUrls ApiUrls => ApiUrlsLookups.SnapshotDeleteRepository;
/// <summary>/_snapshot/{repository}</summary>
/// <param name="repository">this parameter is required</param>
public DeleteRepositoryRequest(Names repository)
: base(r => r.Required("repository", repository)) { }
/// <summary>Used for serialization purposes, making sure we have a parameterless constructor</summary>
[SerializationConstructor]
protected DeleteRepositoryRequest()
: base() { }
// values part of the url path
[IgnoreDataMember]
Names IDeleteRepositoryRequest.RepositoryName => Self.RouteValues.Get<Names>("repository");
// Request parameters
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
public Time ClusterManagerTimeout
{
get => Q<Time>("cluster_manager_timeout");
set => Q("cluster_manager_timeout", value);
}
/// <summary>Explicit operation timeout for connection to master node.</summary>
[Obsolete(
"Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead."
)]
public Time MasterTimeout
{
get => Q<Time>("master_timeout");
set => Q("master_timeout", value);
}
/// <summary>Explicit operation timeout.</summary>
public Time Timeout
{
get => Q<Time>("timeout");
set => Q("timeout", value);
}
}
[InterfaceDataContract]
public partial interface IGetSnapshotRequest : IRequest<GetSnapshotRequestParameters>
{
[IgnoreDataMember]
Name RepositoryName { get; }
[IgnoreDataMember]
Names Snapshot { get; }
}
/// <summary>Request for Get <para>https://opensearch.org/docs/latest</para></summary>
public partial class GetSnapshotRequest
: PlainRequestBase<GetSnapshotRequestParameters>,
IGetSnapshotRequest
{
protected IGetSnapshotRequest Self => this;
internal override ApiUrls ApiUrls => ApiUrlsLookups.SnapshotGet;
/// <summary>/_snapshot/{repository}/{snapshot}</summary>
/// <param name="repository">this parameter is required</param>
/// <param name="snapshot">this parameter is required</param>
public GetSnapshotRequest(Name repository, Names snapshot)
: base(r => r.Required("repository", repository).Required("snapshot", snapshot)) { }
/// <summary>Used for serialization purposes, making sure we have a parameterless constructor</summary>
[SerializationConstructor]
protected GetSnapshotRequest()
: base() { }
// values part of the url path
[IgnoreDataMember]
Name IGetSnapshotRequest.RepositoryName => Self.RouteValues.Get<Name>("repository");
[IgnoreDataMember]
Names IGetSnapshotRequest.Snapshot => Self.RouteValues.Get<Names>("snapshot");
// Request parameters
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
public Time ClusterManagerTimeout
{
get => Q<Time>("cluster_manager_timeout");
set => Q("cluster_manager_timeout", value);
}
/// <summary>If false, the request returns an error for any snapshots that are unavailable.</summary>
public bool? IgnoreUnavailable
{
get => Q<bool?>("ignore_unavailable");
set => Q("ignore_unavailable", value);
}
/// <summary>
/// Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns
/// an error.
/// </summary>
[Obsolete(
"Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead."
)]
public Time MasterTimeout
{
get => Q<Time>("master_timeout");
set => Q("master_timeout", value);
}
/// <summary>
/// If true, returns additional information about each snapshot such as the version of Opensearch which took the snapshot, the start and end
/// times of the snapshot, and the number of shards snapshotted.
/// </summary>
public bool? Verbose
{
get => Q<bool?>("verbose");
set => Q("verbose", value);
}
}
[InterfaceDataContract]
public partial interface IGetRepositoryRequest : IRequest<GetRepositoryRequestParameters>
{
[IgnoreDataMember]
Names RepositoryName { get; }
}
/// <summary>Request for GetRepository <para>https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/</para></summary>
public partial class GetRepositoryRequest
: PlainRequestBase<GetRepositoryRequestParameters>,
IGetRepositoryRequest
{
protected IGetRepositoryRequest Self => this;
internal override ApiUrls ApiUrls => ApiUrlsLookups.SnapshotGetRepository;
/// <summary>/_snapshot</summary>
public GetRepositoryRequest()
: base() { }
/// <summary>/_snapshot/{repository}</summary>
/// <param name="repository">Optional, accepts null</param>
public GetRepositoryRequest(Names repository)
: base(r => r.Optional("repository", repository)) { }
// values part of the url path
[IgnoreDataMember]
Names IGetRepositoryRequest.RepositoryName => Self.RouteValues.Get<Names>("repository");
// Request parameters
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
public Time ClusterManagerTimeout
{
get => Q<Time>("cluster_manager_timeout");
set => Q("cluster_manager_timeout", value);
}
/// <summary>Return local information, do not retrieve the state from cluster-manager node (default: false).</summary>
public bool? Local
{
get => Q<bool?>("local");
set => Q("local", value);
}
/// <summary>Explicit operation timeout for connection to master node.</summary>
[Obsolete(
"Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead."
)]
public Time MasterTimeout
{
get => Q<Time>("master_timeout");
set => Q("master_timeout", value);
}
}
[InterfaceDataContract]
public partial interface IRestoreRequest : IRequest<RestoreRequestParameters>
{
[IgnoreDataMember]
Name RepositoryName { get; }
[IgnoreDataMember]
Name Snapshot { get; }
}
/// <summary>Request for Restore <para>https://opensearch.org/docs/latest/api-reference/snapshots/restore-snapshot/</para></summary>
public partial class RestoreRequest
: PlainRequestBase<RestoreRequestParameters>,
IRestoreRequest
{
protected IRestoreRequest Self => this;
internal override ApiUrls ApiUrls => ApiUrlsLookups.SnapshotRestore;
/// <summary>/_snapshot/{repository}/{snapshot}/_restore</summary>
/// <param name="repository">this parameter is required</param>
/// <param name="snapshot">this parameter is required</param>
public RestoreRequest(Name repository, Name snapshot)
: base(r => r.Required("repository", repository).Required("snapshot", snapshot)) { }
/// <summary>Used for serialization purposes, making sure we have a parameterless constructor</summary>
[SerializationConstructor]
protected RestoreRequest()
: base() { }
// values part of the url path
[IgnoreDataMember]
Name IRestoreRequest.RepositoryName => Self.RouteValues.Get<Name>("repository");
[IgnoreDataMember]
Name IRestoreRequest.Snapshot => Self.RouteValues.Get<Name>("snapshot");
// Request parameters
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
public Time ClusterManagerTimeout
{
get => Q<Time>("cluster_manager_timeout");
set => Q("cluster_manager_timeout", value);
}
/// <summary>Explicit operation timeout for connection to master node.</summary>
[Obsolete(
"Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead."
)]
public Time MasterTimeout
{
get => Q<Time>("master_timeout");
set => Q("master_timeout", value);
}
/// <summary>Should this request wait until the operation has completed before returning.</summary>
public bool? WaitForCompletion
{
get => Q<bool?>("wait_for_completion");
set => Q("wait_for_completion", value);
}
}
[InterfaceDataContract]
public partial interface ISnapshotStatusRequest : IRequest<SnapshotStatusRequestParameters>
{
[IgnoreDataMember]
Name RepositoryName { get; }
[IgnoreDataMember]
Names Snapshot { get; }
}
/// <summary>Request for Status <para>https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-status/</para></summary>
public partial class SnapshotStatusRequest
: PlainRequestBase<SnapshotStatusRequestParameters>,
ISnapshotStatusRequest
{
protected ISnapshotStatusRequest Self => this;
internal override ApiUrls ApiUrls => ApiUrlsLookups.SnapshotStatus;
/// <summary>/_snapshot/_status</summary>
public SnapshotStatusRequest()
: base() { }
/// <summary>/_snapshot/{repository}/_status</summary>
/// <param name="repository">Optional, accepts null</param>
public SnapshotStatusRequest(Name repository)
: base(r => r.Optional("repository", repository)) { }
/// <summary>/_snapshot/{repository}/{snapshot}/_status</summary>
/// <param name="repository">Optional, accepts null</param>
/// <param name="snapshot">Optional, accepts null</param>
public SnapshotStatusRequest(Name repository, Names snapshot)
: base(r => r.Optional("repository", repository).Optional("snapshot", snapshot)) { }
// values part of the url path
[IgnoreDataMember]
Name ISnapshotStatusRequest.RepositoryName => Self.RouteValues.Get<Name>("repository");
[IgnoreDataMember]
Names ISnapshotStatusRequest.Snapshot => Self.RouteValues.Get<Names>("snapshot");
// Request parameters
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
public Time ClusterManagerTimeout
{
get => Q<Time>("cluster_manager_timeout");
set => Q("cluster_manager_timeout", value);
}
/// <summary>Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown.</summary>
public bool? IgnoreUnavailable
{
get => Q<bool?>("ignore_unavailable");
set => Q("ignore_unavailable", value);
}
/// <summary>Explicit operation timeout for connection to master node.</summary>
[Obsolete(
"Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead."
)]
public Time MasterTimeout
{
get => Q<Time>("master_timeout");
set => Q("master_timeout", value);
}
}
[InterfaceDataContract]
public partial interface IVerifyRepositoryRequest : IRequest<VerifyRepositoryRequestParameters>
{
[IgnoreDataMember]
Name RepositoryName { get; }
}
/// <summary>Request for VerifyRepository <para>https://opensearch.org/docs/latest/api-reference/snapshots/verify-snapshot-repository/</para></summary>
public partial class VerifyRepositoryRequest
: PlainRequestBase<VerifyRepositoryRequestParameters>,
IVerifyRepositoryRequest
{
protected IVerifyRepositoryRequest Self => this;
internal override ApiUrls ApiUrls => ApiUrlsLookups.SnapshotVerifyRepository;
/// <summary>/_snapshot/{repository}/_verify</summary>
/// <param name="repository">this parameter is required</param>
public VerifyRepositoryRequest(Name repository)
: base(r => r.Required("repository", repository)) { }
/// <summary>Used for serialization purposes, making sure we have a parameterless constructor</summary>
[SerializationConstructor]
protected VerifyRepositoryRequest()
: base() { }
// values part of the url path
[IgnoreDataMember]
Name IVerifyRepositoryRequest.RepositoryName => Self.RouteValues.Get<Name>("repository");
// Request parameters
/// <summary>Operation timeout for connection to cluster-manager node.</summary>
/// <remarks>Supported by OpenSearch servers of version 2.0.0 or greater.</remarks>
public Time ClusterManagerTimeout
{
get => Q<Time>("cluster_manager_timeout");
set => Q("cluster_manager_timeout", value);
}
/// <summary>Explicit operation timeout for connection to master node.</summary>
[Obsolete(
"Deprecated as of: 2.0.0, reason: To promote inclusive language, use 'cluster_manager_timeout' instead."
)]
public Time MasterTimeout
{
get => Q<Time>("master_timeout");
set => Q("master_timeout", value);
}
/// <summary>Explicit operation timeout.</summary>
public Time Timeout
{
get => Q<Time>("timeout");
set => Q("timeout", value);
}
}
}