forked from googleapis/google-cloud-cpp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathinstance_admin_client.h
2625 lines (2553 loc) · 143 KB
/
instance_admin_client.h
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
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2021 Google LLC
//
// Licensed 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
//
// https://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.
// Generated by the Codegen C++ plugin.
// If you make any local changes, they will be lost.
// source: google/spanner/admin/instance/v1/spanner_instance_admin.proto
#ifndef GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_SPANNER_ADMIN_INSTANCE_ADMIN_CLIENT_H
#define GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_SPANNER_ADMIN_INSTANCE_ADMIN_CLIENT_H
#include "google/cloud/spanner/admin/instance_admin_connection.h"
#include "google/cloud/future.h"
#include "google/cloud/iam_updater.h"
#include "google/cloud/internal/make_status.h"
#include "google/cloud/no_await_tag.h"
#include "google/cloud/options.h"
#include "google/cloud/polling_policy.h"
#include "google/cloud/status_or.h"
#include "google/cloud/version.h"
#include <google/longrunning/operations.grpc.pb.h>
#include <map>
#include <memory>
#include <string>
namespace google {
namespace cloud {
namespace spanner_admin {
GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
///
/// Cloud Spanner Instance Admin API
///
/// The Cloud Spanner Instance Admin API can be used to create, delete,
/// modify and list instances. Instances are dedicated Cloud Spanner serving
/// and storage resources to be used by Cloud Spanner databases.
///
/// Each instance has a "configuration", which dictates where the
/// serving resources for the Cloud Spanner instance are located (e.g.,
/// US-central, Europe). Configurations are created by Google based on
/// resource availability.
///
/// Cloud Spanner billing is based on the instances that exist and their
/// sizes. After an instance exists, there are no additional
/// per-database or per-operation charges for use of the instance
/// (though there may be additional network bandwidth charges).
/// Instances offer isolation: problems with databases in one instance
/// will not affect other instances. However, within an instance
/// databases can affect each other. For example, if one database in an
/// instance receives a lot of requests and consumes most of the
/// instance resources, fewer resources are available for other
/// databases in that instance, and their performance may suffer.
///
/// @par Equality
///
/// Instances of this class created via copy-construction or copy-assignment
/// always compare equal. Instances created with equal
/// `std::shared_ptr<*Connection>` objects compare equal. Objects that compare
/// equal share the same underlying resources.
///
/// @par Performance
///
/// Creating a new instance of this class is a relatively expensive operation,
/// new objects establish new connections to the service. In contrast,
/// copy-construction, move-construction, and the corresponding assignment
/// operations are relatively efficient as the copies share all underlying
/// resources.
///
/// @par Thread Safety
///
/// Concurrent access to different instances of this class, even if they compare
/// equal, is guaranteed to work. Two or more threads operating on the same
/// instance of this class is not guaranteed to work. Since copy-construction
/// and move-construction is a relatively efficient operation, consider using
/// such a copy when using this class from multiple threads.
///
class InstanceAdminClient {
public:
explicit InstanceAdminClient(
std::shared_ptr<InstanceAdminConnection> connection, Options opts = {});
~InstanceAdminClient();
///@{
/// @name Copy and move support
InstanceAdminClient(InstanceAdminClient const&) = default;
InstanceAdminClient& operator=(InstanceAdminClient const&) = default;
InstanceAdminClient(InstanceAdminClient&&) = default;
InstanceAdminClient& operator=(InstanceAdminClient&&) = default;
///@}
///@{
/// @name Equality
friend bool operator==(InstanceAdminClient const& a,
InstanceAdminClient const& b) {
return a.connection_ == b.connection_;
}
friend bool operator!=(InstanceAdminClient const& a,
InstanceAdminClient const& b) {
return !(a == b);
}
///@}
// clang-format off
///
/// Lists the supported instance configurations for a given project.
///
/// @param parent Required. The name of the project for which a list of supported instance
/// configurations is requested. Values are of the form
/// `projects/<project>`.
/// @param opts Optional. Override the class-level options, such as retry and
/// backoff policies.
/// @return a [StreamRange](@ref google::cloud::StreamRange)
/// to iterate of the results. See the documentation of this type for
/// details. In brief, this class has `begin()` and `end()` member
/// functions returning a iterator class meeting the
/// [input iterator requirements]. The value type for this iterator is a
/// [`StatusOr`] as the iteration may fail even after some values are
/// retrieved successfully, for example, if there is a network disconnect.
/// An empty set of results does not indicate an error, it indicates
/// that there are no resources meeting the request criteria.
/// On a successful iteration the `StatusOr<T>` contains elements of type
/// [google.spanner.admin.instance.v1.InstanceConfig], or rather,
/// the C++ class generated by Protobuf from that type. Please consult the
/// Protobuf documentation for details on the [Protobuf mapping rules].
///
/// [Protobuf mapping rules]: https://protobuf.dev/reference/cpp/cpp-generated/
/// [input iterator requirements]: https://en.cppreference.com/w/cpp/named_req/InputIterator
/// [`std::string`]: https://en.cppreference.com/w/cpp/string/basic_string
/// [`future`]: @ref google::cloud::future
/// [`StatusOr`]: @ref google::cloud::StatusOr
/// [`Status`]: @ref google::cloud::Status
/// [google.spanner.admin.instance.v1.InstanceConfig]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L694}
/// [google.spanner.admin.instance.v1.ListInstanceConfigsRequest]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1130}
///
// clang-format on
StreamRange<google::spanner::admin::instance::v1::InstanceConfig>
ListInstanceConfigs(std::string const& parent, Options opts = {});
// clang-format off
///
/// Lists the supported instance configurations for a given project.
///
/// @param request Unary RPCs, such as the one wrapped by this
/// function, receive a single `request` proto message which includes all
/// the inputs for the RPC. In this case, the proto message is a
/// [google.spanner.admin.instance.v1.ListInstanceConfigsRequest].
/// Proto messages are converted to C++ classes by Protobuf, using the
/// [Protobuf mapping rules].
/// @param opts Optional. Override the class-level options, such as retry and
/// backoff policies.
/// @return a [StreamRange](@ref google::cloud::StreamRange)
/// to iterate of the results. See the documentation of this type for
/// details. In brief, this class has `begin()` and `end()` member
/// functions returning a iterator class meeting the
/// [input iterator requirements]. The value type for this iterator is a
/// [`StatusOr`] as the iteration may fail even after some values are
/// retrieved successfully, for example, if there is a network disconnect.
/// An empty set of results does not indicate an error, it indicates
/// that there are no resources meeting the request criteria.
/// On a successful iteration the `StatusOr<T>` contains elements of type
/// [google.spanner.admin.instance.v1.InstanceConfig], or rather,
/// the C++ class generated by Protobuf from that type. Please consult the
/// Protobuf documentation for details on the [Protobuf mapping rules].
///
/// [Protobuf mapping rules]: https://protobuf.dev/reference/cpp/cpp-generated/
/// [input iterator requirements]: https://en.cppreference.com/w/cpp/named_req/InputIterator
/// [`std::string`]: https://en.cppreference.com/w/cpp/string/basic_string
/// [`future`]: @ref google::cloud::future
/// [`StatusOr`]: @ref google::cloud::StatusOr
/// [`Status`]: @ref google::cloud::Status
/// [google.spanner.admin.instance.v1.InstanceConfig]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L694}
/// [google.spanner.admin.instance.v1.ListInstanceConfigsRequest]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1130}
///
// clang-format on
StreamRange<google::spanner::admin::instance::v1::InstanceConfig>
ListInstanceConfigs(
google::spanner::admin::instance::v1::ListInstanceConfigsRequest request,
Options opts = {});
// clang-format off
///
/// Gets information about a particular instance configuration.
///
/// @param name Required. The name of the requested instance configuration. Values are of
/// the form `projects/<project>/instanceConfigs/<config>`.
/// @param opts Optional. Override the class-level options, such as retry and
/// backoff policies.
/// @return the result of the RPC. The response message type
/// ([google.spanner.admin.instance.v1.InstanceConfig])
/// is mapped to a C++ class using the [Protobuf mapping rules].
/// If the request fails, the [`StatusOr`] contains the error details.
///
/// [Protobuf mapping rules]: https://protobuf.dev/reference/cpp/cpp-generated/
/// [input iterator requirements]: https://en.cppreference.com/w/cpp/named_req/InputIterator
/// [`std::string`]: https://en.cppreference.com/w/cpp/string/basic_string
/// [`future`]: @ref google::cloud::future
/// [`StatusOr`]: @ref google::cloud::StatusOr
/// [`Status`]: @ref google::cloud::Status
/// [google.spanner.admin.instance.v1.GetInstanceConfigRequest]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1166}
/// [google.spanner.admin.instance.v1.InstanceConfig]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L694}
///
// clang-format on
StatusOr<google::spanner::admin::instance::v1::InstanceConfig>
GetInstanceConfig(std::string const& name, Options opts = {});
// clang-format off
///
/// Gets information about a particular instance configuration.
///
/// @param request Unary RPCs, such as the one wrapped by this
/// function, receive a single `request` proto message which includes all
/// the inputs for the RPC. In this case, the proto message is a
/// [google.spanner.admin.instance.v1.GetInstanceConfigRequest].
/// Proto messages are converted to C++ classes by Protobuf, using the
/// [Protobuf mapping rules].
/// @param opts Optional. Override the class-level options, such as retry and
/// backoff policies.
/// @return the result of the RPC. The response message type
/// ([google.spanner.admin.instance.v1.InstanceConfig])
/// is mapped to a C++ class using the [Protobuf mapping rules].
/// If the request fails, the [`StatusOr`] contains the error details.
///
/// [Protobuf mapping rules]: https://protobuf.dev/reference/cpp/cpp-generated/
/// [input iterator requirements]: https://en.cppreference.com/w/cpp/named_req/InputIterator
/// [`std::string`]: https://en.cppreference.com/w/cpp/string/basic_string
/// [`future`]: @ref google::cloud::future
/// [`StatusOr`]: @ref google::cloud::StatusOr
/// [`Status`]: @ref google::cloud::Status
/// [google.spanner.admin.instance.v1.GetInstanceConfigRequest]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1166}
/// [google.spanner.admin.instance.v1.InstanceConfig]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L694}
///
// clang-format on
StatusOr<google::spanner::admin::instance::v1::InstanceConfig>
GetInstanceConfig(
google::spanner::admin::instance::v1::GetInstanceConfigRequest const&
request,
Options opts = {});
// clang-format off
///
/// Creates an instance configuration and begins preparing it to be used. The
/// returned [long-running operation][google.longrunning.Operation]
/// can be used to track the progress of preparing the new
/// instance configuration. The instance configuration name is assigned by the
/// caller. If the named instance configuration already exists,
/// `CreateInstanceConfig` returns `ALREADY_EXISTS`.
///
/// Immediately after the request returns:
///
/// * The instance configuration is readable via the API, with all requested
/// attributes. The instance configuration's
/// [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
/// field is set to true. Its state is `CREATING`.
///
/// While the operation is pending:
///
/// * Cancelling the operation renders the instance configuration immediately
/// unreadable via the API.
/// * Except for deleting the creating resource, all other attempts to modify
/// the instance configuration are rejected.
///
/// Upon completion of the returned operation:
///
/// * Instances can be created using the instance configuration.
/// * The instance configuration's
/// [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
/// field becomes false. Its state becomes `READY`.
///
/// The returned [long-running operation][google.longrunning.Operation] will
/// have a name of the format
/// `<instance_config_name>/operations/<operation_id>` and can be used to track
/// creation of the instance configuration. The
/// [metadata][google.longrunning.Operation.metadata] field type is
/// [CreateInstanceConfigMetadata][google.spanner.admin.instance.v1.CreateInstanceConfigMetadata].
/// The [response][google.longrunning.Operation.response] field type is
/// [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if
/// successful.
///
/// Authorization requires `spanner.instanceConfigs.create` permission on
/// the resource
/// [parent][google.spanner.admin.instance.v1.CreateInstanceConfigRequest.parent].
///
/// @param parent Required. The name of the project in which to create the instance
/// configuration. Values are of the form `projects/<project>`.
/// @param instance_config Required. The InstanceConfig proto of the configuration to create.
/// instance_config.name must be
/// `<parent>/instanceConfigs/<instance_config_id>`.
/// instance_config.base_config must be a Google managed configuration name,
/// e.g. `<parent>/instanceConfigs/us-east1`, `<parent>/instanceConfigs/nam3`.
/// @param instance_config_id Required. The ID of the instance configuration to create. Valid identifiers
/// are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64
/// characters in length. The `custom-` prefix is required to avoid name
/// conflicts with Google-managed configurations.
/// @param opts Optional. Override the class-level options, such as retry and
/// backoff policies.
/// @return A [`future`] that becomes satisfied when the LRO
/// ([Long Running Operation]) completes or the polling policy in effect
/// for this call is exhausted. The future is satisfied with an error if
/// the LRO completes with an error or the polling policy is exhausted.
/// In this case the [`StatusOr`] returned by the future contains the
/// error. If the LRO completes successfully the value of the future
/// contains the LRO's result. For this RPC the result is a
/// [google.spanner.admin.instance.v1.InstanceConfig] proto message.
/// The C++ class representing this message is created by Protobuf, using
/// the [Protobuf mapping rules].
///
/// [Protobuf mapping rules]: https://protobuf.dev/reference/cpp/cpp-generated/
/// [input iterator requirements]: https://en.cppreference.com/w/cpp/named_req/InputIterator
/// [Long Running Operation]: https://google.aip.dev/151
/// [`std::string`]: https://en.cppreference.com/w/cpp/string/basic_string
/// [`future`]: @ref google::cloud::future
/// [`StatusOr`]: @ref google::cloud::StatusOr
/// [`Status`]: @ref google::cloud::Status
/// [google.longrunning.Operation]: @googleapis_reference_link{google/longrunning/operations.proto#L121}
/// [google.longrunning.Operation.metadata]: @googleapis_reference_link{google/longrunning/operations.proto#L131}
/// [google.longrunning.Operation.response]: @googleapis_reference_link{google/longrunning/operations.proto#L154}
/// [google.spanner.admin.instance.v1.CreateInstanceConfigMetadata]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1535}
/// [google.spanner.admin.instance.v1.CreateInstanceConfigRequest]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1179}
/// [google.spanner.admin.instance.v1.CreateInstanceConfigRequest.parent]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1182}
/// [google.spanner.admin.instance.v1.InstanceConfig]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L694}
/// [google.spanner.admin.instance.v1.InstanceConfig.reconciling]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L799}
///
// clang-format on
future<StatusOr<google::spanner::admin::instance::v1::InstanceConfig>>
CreateInstanceConfig(
std::string const& parent,
google::spanner::admin::instance::v1::InstanceConfig const&
instance_config,
std::string const& instance_config_id, Options opts = {});
// clang-format off
///
/// @copybrief CreateInstanceConfig
///
/// Specifying the [`NoAwaitTag`] immediately returns the
/// [`google::longrunning::Operation`] that corresponds to the Long Running
/// Operation that has been started. No polling for operation status occurs.
///
/// [`NoAwaitTag`]: @ref google::cloud::NoAwaitTag
///
// clang-format on
StatusOr<google::longrunning::Operation> CreateInstanceConfig(
NoAwaitTag, std::string const& parent,
google::spanner::admin::instance::v1::InstanceConfig const&
instance_config,
std::string const& instance_config_id, Options opts = {});
// clang-format off
///
/// Creates an instance configuration and begins preparing it to be used. The
/// returned [long-running operation][google.longrunning.Operation]
/// can be used to track the progress of preparing the new
/// instance configuration. The instance configuration name is assigned by the
/// caller. If the named instance configuration already exists,
/// `CreateInstanceConfig` returns `ALREADY_EXISTS`.
///
/// Immediately after the request returns:
///
/// * The instance configuration is readable via the API, with all requested
/// attributes. The instance configuration's
/// [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
/// field is set to true. Its state is `CREATING`.
///
/// While the operation is pending:
///
/// * Cancelling the operation renders the instance configuration immediately
/// unreadable via the API.
/// * Except for deleting the creating resource, all other attempts to modify
/// the instance configuration are rejected.
///
/// Upon completion of the returned operation:
///
/// * Instances can be created using the instance configuration.
/// * The instance configuration's
/// [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
/// field becomes false. Its state becomes `READY`.
///
/// The returned [long-running operation][google.longrunning.Operation] will
/// have a name of the format
/// `<instance_config_name>/operations/<operation_id>` and can be used to track
/// creation of the instance configuration. The
/// [metadata][google.longrunning.Operation.metadata] field type is
/// [CreateInstanceConfigMetadata][google.spanner.admin.instance.v1.CreateInstanceConfigMetadata].
/// The [response][google.longrunning.Operation.response] field type is
/// [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if
/// successful.
///
/// Authorization requires `spanner.instanceConfigs.create` permission on
/// the resource
/// [parent][google.spanner.admin.instance.v1.CreateInstanceConfigRequest.parent].
///
/// @param request Unary RPCs, such as the one wrapped by this
/// function, receive a single `request` proto message which includes all
/// the inputs for the RPC. In this case, the proto message is a
/// [google.spanner.admin.instance.v1.CreateInstanceConfigRequest].
/// Proto messages are converted to C++ classes by Protobuf, using the
/// [Protobuf mapping rules].
/// @param opts Optional. Override the class-level options, such as retry and
/// backoff policies.
/// @return A [`future`] that becomes satisfied when the LRO
/// ([Long Running Operation]) completes or the polling policy in effect
/// for this call is exhausted. The future is satisfied with an error if
/// the LRO completes with an error or the polling policy is exhausted.
/// In this case the [`StatusOr`] returned by the future contains the
/// error. If the LRO completes successfully the value of the future
/// contains the LRO's result. For this RPC the result is a
/// [google.spanner.admin.instance.v1.InstanceConfig] proto message.
/// The C++ class representing this message is created by Protobuf, using
/// the [Protobuf mapping rules].
///
/// [Protobuf mapping rules]: https://protobuf.dev/reference/cpp/cpp-generated/
/// [input iterator requirements]: https://en.cppreference.com/w/cpp/named_req/InputIterator
/// [Long Running Operation]: https://google.aip.dev/151
/// [`std::string`]: https://en.cppreference.com/w/cpp/string/basic_string
/// [`future`]: @ref google::cloud::future
/// [`StatusOr`]: @ref google::cloud::StatusOr
/// [`Status`]: @ref google::cloud::Status
/// [google.longrunning.Operation]: @googleapis_reference_link{google/longrunning/operations.proto#L121}
/// [google.longrunning.Operation.metadata]: @googleapis_reference_link{google/longrunning/operations.proto#L131}
/// [google.longrunning.Operation.response]: @googleapis_reference_link{google/longrunning/operations.proto#L154}
/// [google.spanner.admin.instance.v1.CreateInstanceConfigMetadata]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1535}
/// [google.spanner.admin.instance.v1.CreateInstanceConfigRequest]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1179}
/// [google.spanner.admin.instance.v1.CreateInstanceConfigRequest.parent]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1182}
/// [google.spanner.admin.instance.v1.InstanceConfig]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L694}
/// [google.spanner.admin.instance.v1.InstanceConfig.reconciling]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L799}
///
// clang-format on
future<StatusOr<google::spanner::admin::instance::v1::InstanceConfig>>
CreateInstanceConfig(
google::spanner::admin::instance::v1::CreateInstanceConfigRequest const&
request,
Options opts = {});
// clang-format off
///
/// @copybrief CreateInstanceConfig
///
/// Specifying the [`NoAwaitTag`] immediately returns the
/// [`google::longrunning::Operation`] that corresponds to the Long Running
/// Operation that has been started. No polling for operation status occurs.
///
/// [`NoAwaitTag`]: @ref google::cloud::NoAwaitTag
///
// clang-format on
StatusOr<google::longrunning::Operation> CreateInstanceConfig(
NoAwaitTag,
google::spanner::admin::instance::v1::CreateInstanceConfigRequest const&
request,
Options opts = {});
// clang-format off
///
/// @copybrief CreateInstanceConfig
///
/// This method accepts a `google::longrunning::Operation` that corresponds
/// to a previously started Long Running Operation (LRO) and polls the status
/// of the LRO in the background.
///
// clang-format on
future<StatusOr<google::spanner::admin::instance::v1::InstanceConfig>>
CreateInstanceConfig(google::longrunning::Operation const& operation,
Options opts = {});
// clang-format off
///
/// Updates an instance configuration. The returned
/// [long-running operation][google.longrunning.Operation] can be used to track
/// the progress of updating the instance. If the named instance configuration
/// does not exist, returns `NOT_FOUND`.
///
/// Only user-managed configurations can be updated.
///
/// Immediately after the request returns:
///
/// * The instance configuration's
/// [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
/// field is set to true.
///
/// While the operation is pending:
///
/// * Cancelling the operation sets its metadata's
/// [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata.cancel_time].
/// The operation is guaranteed to succeed at undoing all changes, after
/// which point it terminates with a `CANCELLED` status.
/// * All other attempts to modify the instance configuration are rejected.
/// * Reading the instance configuration via the API continues to give the
/// pre-request values.
///
/// Upon completion of the returned operation:
///
/// * Creating instances using the instance configuration uses the new
/// values.
/// * The new values of the instance configuration are readable via the API.
/// * The instance configuration's
/// [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
/// field becomes false.
///
/// The returned [long-running operation][google.longrunning.Operation] will
/// have a name of the format
/// `<instance_config_name>/operations/<operation_id>` and can be used to track
/// the instance configuration modification. The
/// [metadata][google.longrunning.Operation.metadata] field type is
/// [UpdateInstanceConfigMetadata][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata].
/// The [response][google.longrunning.Operation.response] field type is
/// [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if
/// successful.
///
/// Authorization requires `spanner.instanceConfigs.update` permission on
/// the resource [name][google.spanner.admin.instance.v1.InstanceConfig.name].
///
/// @param instance_config Required. The user instance configuration to update, which must always
/// include the instance configuration name. Otherwise, only fields mentioned
/// in
/// [update_mask][google.spanner.admin.instance.v1.UpdateInstanceConfigRequest.update_mask]
/// need be included. To prevent conflicts of concurrent updates,
/// [etag][google.spanner.admin.instance.v1.InstanceConfig.reconciling] can
/// be used.
/// @param update_mask Required. A mask specifying which fields in
/// [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] should be
/// updated. The field mask must always be specified; this prevents any future
/// fields in [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig]
/// from being erased accidentally by clients that do not know about them. Only
/// display_name and labels can be updated.
/// @param opts Optional. Override the class-level options, such as retry and
/// backoff policies.
/// @return A [`future`] that becomes satisfied when the LRO
/// ([Long Running Operation]) completes or the polling policy in effect
/// for this call is exhausted. The future is satisfied with an error if
/// the LRO completes with an error or the polling policy is exhausted.
/// In this case the [`StatusOr`] returned by the future contains the
/// error. If the LRO completes successfully the value of the future
/// contains the LRO's result. For this RPC the result is a
/// [google.spanner.admin.instance.v1.InstanceConfig] proto message.
/// The C++ class representing this message is created by Protobuf, using
/// the [Protobuf mapping rules].
///
/// [Protobuf mapping rules]: https://protobuf.dev/reference/cpp/cpp-generated/
/// [input iterator requirements]: https://en.cppreference.com/w/cpp/named_req/InputIterator
/// [Long Running Operation]: https://google.aip.dev/151
/// [`std::string`]: https://en.cppreference.com/w/cpp/string/basic_string
/// [`future`]: @ref google::cloud::future
/// [`StatusOr`]: @ref google::cloud::StatusOr
/// [`Status`]: @ref google::cloud::Status
/// [google.longrunning.Operation]: @googleapis_reference_link{google/longrunning/operations.proto#L121}
/// [google.longrunning.Operation.metadata]: @googleapis_reference_link{google/longrunning/operations.proto#L131}
/// [google.longrunning.Operation.response]: @googleapis_reference_link{google/longrunning/operations.proto#L154}
/// [google.spanner.admin.instance.v1.InstanceConfig]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L694}
/// [google.spanner.admin.instance.v1.InstanceConfig.name]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L730}
/// [google.spanner.admin.instance.v1.InstanceConfig.reconciling]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L799}
/// [google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1550}
/// [google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata.cancel_time]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1560}
/// [google.spanner.admin.instance.v1.UpdateInstanceConfigRequest]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1209}
/// [google.spanner.admin.instance.v1.UpdateInstanceConfigRequest.update_mask]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1225}
///
// clang-format on
future<StatusOr<google::spanner::admin::instance::v1::InstanceConfig>>
UpdateInstanceConfig(
google::spanner::admin::instance::v1::InstanceConfig const&
instance_config,
google::protobuf::FieldMask const& update_mask, Options opts = {});
// clang-format off
///
/// @copybrief UpdateInstanceConfig
///
/// Specifying the [`NoAwaitTag`] immediately returns the
/// [`google::longrunning::Operation`] that corresponds to the Long Running
/// Operation that has been started. No polling for operation status occurs.
///
/// [`NoAwaitTag`]: @ref google::cloud::NoAwaitTag
///
// clang-format on
StatusOr<google::longrunning::Operation> UpdateInstanceConfig(
NoAwaitTag,
google::spanner::admin::instance::v1::InstanceConfig const&
instance_config,
google::protobuf::FieldMask const& update_mask, Options opts = {});
// clang-format off
///
/// Updates an instance configuration. The returned
/// [long-running operation][google.longrunning.Operation] can be used to track
/// the progress of updating the instance. If the named instance configuration
/// does not exist, returns `NOT_FOUND`.
///
/// Only user-managed configurations can be updated.
///
/// Immediately after the request returns:
///
/// * The instance configuration's
/// [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
/// field is set to true.
///
/// While the operation is pending:
///
/// * Cancelling the operation sets its metadata's
/// [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata.cancel_time].
/// The operation is guaranteed to succeed at undoing all changes, after
/// which point it terminates with a `CANCELLED` status.
/// * All other attempts to modify the instance configuration are rejected.
/// * Reading the instance configuration via the API continues to give the
/// pre-request values.
///
/// Upon completion of the returned operation:
///
/// * Creating instances using the instance configuration uses the new
/// values.
/// * The new values of the instance configuration are readable via the API.
/// * The instance configuration's
/// [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
/// field becomes false.
///
/// The returned [long-running operation][google.longrunning.Operation] will
/// have a name of the format
/// `<instance_config_name>/operations/<operation_id>` and can be used to track
/// the instance configuration modification. The
/// [metadata][google.longrunning.Operation.metadata] field type is
/// [UpdateInstanceConfigMetadata][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata].
/// The [response][google.longrunning.Operation.response] field type is
/// [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if
/// successful.
///
/// Authorization requires `spanner.instanceConfigs.update` permission on
/// the resource [name][google.spanner.admin.instance.v1.InstanceConfig.name].
///
/// @param request Unary RPCs, such as the one wrapped by this
/// function, receive a single `request` proto message which includes all
/// the inputs for the RPC. In this case, the proto message is a
/// [google.spanner.admin.instance.v1.UpdateInstanceConfigRequest].
/// Proto messages are converted to C++ classes by Protobuf, using the
/// [Protobuf mapping rules].
/// @param opts Optional. Override the class-level options, such as retry and
/// backoff policies.
/// @return A [`future`] that becomes satisfied when the LRO
/// ([Long Running Operation]) completes or the polling policy in effect
/// for this call is exhausted. The future is satisfied with an error if
/// the LRO completes with an error or the polling policy is exhausted.
/// In this case the [`StatusOr`] returned by the future contains the
/// error. If the LRO completes successfully the value of the future
/// contains the LRO's result. For this RPC the result is a
/// [google.spanner.admin.instance.v1.InstanceConfig] proto message.
/// The C++ class representing this message is created by Protobuf, using
/// the [Protobuf mapping rules].
///
/// [Protobuf mapping rules]: https://protobuf.dev/reference/cpp/cpp-generated/
/// [input iterator requirements]: https://en.cppreference.com/w/cpp/named_req/InputIterator
/// [Long Running Operation]: https://google.aip.dev/151
/// [`std::string`]: https://en.cppreference.com/w/cpp/string/basic_string
/// [`future`]: @ref google::cloud::future
/// [`StatusOr`]: @ref google::cloud::StatusOr
/// [`Status`]: @ref google::cloud::Status
/// [google.longrunning.Operation]: @googleapis_reference_link{google/longrunning/operations.proto#L121}
/// [google.longrunning.Operation.metadata]: @googleapis_reference_link{google/longrunning/operations.proto#L131}
/// [google.longrunning.Operation.response]: @googleapis_reference_link{google/longrunning/operations.proto#L154}
/// [google.spanner.admin.instance.v1.InstanceConfig]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L694}
/// [google.spanner.admin.instance.v1.InstanceConfig.name]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L730}
/// [google.spanner.admin.instance.v1.InstanceConfig.reconciling]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L799}
/// [google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1550}
/// [google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata.cancel_time]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1560}
/// [google.spanner.admin.instance.v1.UpdateInstanceConfigRequest]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1209}
///
// clang-format on
future<StatusOr<google::spanner::admin::instance::v1::InstanceConfig>>
UpdateInstanceConfig(
google::spanner::admin::instance::v1::UpdateInstanceConfigRequest const&
request,
Options opts = {});
// clang-format off
///
/// @copybrief UpdateInstanceConfig
///
/// Specifying the [`NoAwaitTag`] immediately returns the
/// [`google::longrunning::Operation`] that corresponds to the Long Running
/// Operation that has been started. No polling for operation status occurs.
///
/// [`NoAwaitTag`]: @ref google::cloud::NoAwaitTag
///
// clang-format on
StatusOr<google::longrunning::Operation> UpdateInstanceConfig(
NoAwaitTag,
google::spanner::admin::instance::v1::UpdateInstanceConfigRequest const&
request,
Options opts = {});
// clang-format off
///
/// @copybrief UpdateInstanceConfig
///
/// This method accepts a `google::longrunning::Operation` that corresponds
/// to a previously started Long Running Operation (LRO) and polls the status
/// of the LRO in the background.
///
// clang-format on
future<StatusOr<google::spanner::admin::instance::v1::InstanceConfig>>
UpdateInstanceConfig(google::longrunning::Operation const& operation,
Options opts = {});
// clang-format off
///
/// Deletes the instance configuration. Deletion is only allowed when no
/// instances are using the configuration. If any instances are using
/// the configuration, returns `FAILED_PRECONDITION`.
///
/// Only user-managed configurations can be deleted.
///
/// Authorization requires `spanner.instanceConfigs.delete` permission on
/// the resource [name][google.spanner.admin.instance.v1.InstanceConfig.name].
///
/// @param name Required. The name of the instance configuration to be deleted.
/// Values are of the form
/// `projects/<project>/instanceConfigs/<instance_config>`
/// @param opts Optional. Override the class-level options, such as retry and
/// backoff policies.
/// @return a [`Status`] object. If the request failed, the
/// status contains the details of the failure.
///
/// [Protobuf mapping rules]: https://protobuf.dev/reference/cpp/cpp-generated/
/// [input iterator requirements]: https://en.cppreference.com/w/cpp/named_req/InputIterator
/// [`std::string`]: https://en.cppreference.com/w/cpp/string/basic_string
/// [`future`]: @ref google::cloud::future
/// [`StatusOr`]: @ref google::cloud::StatusOr
/// [`Status`]: @ref google::cloud::Status
/// [google.spanner.admin.instance.v1.DeleteInstanceConfigRequest]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1235}
/// [google.spanner.admin.instance.v1.InstanceConfig.name]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L730}
///
// clang-format on
Status DeleteInstanceConfig(std::string const& name, Options opts = {});
// clang-format off
///
/// Deletes the instance configuration. Deletion is only allowed when no
/// instances are using the configuration. If any instances are using
/// the configuration, returns `FAILED_PRECONDITION`.
///
/// Only user-managed configurations can be deleted.
///
/// Authorization requires `spanner.instanceConfigs.delete` permission on
/// the resource [name][google.spanner.admin.instance.v1.InstanceConfig.name].
///
/// @param request Unary RPCs, such as the one wrapped by this
/// function, receive a single `request` proto message which includes all
/// the inputs for the RPC. In this case, the proto message is a
/// [google.spanner.admin.instance.v1.DeleteInstanceConfigRequest].
/// Proto messages are converted to C++ classes by Protobuf, using the
/// [Protobuf mapping rules].
/// @param opts Optional. Override the class-level options, such as retry and
/// backoff policies.
/// @return a [`Status`] object. If the request failed, the
/// status contains the details of the failure.
///
/// [Protobuf mapping rules]: https://protobuf.dev/reference/cpp/cpp-generated/
/// [input iterator requirements]: https://en.cppreference.com/w/cpp/named_req/InputIterator
/// [`std::string`]: https://en.cppreference.com/w/cpp/string/basic_string
/// [`future`]: @ref google::cloud::future
/// [`StatusOr`]: @ref google::cloud::StatusOr
/// [`Status`]: @ref google::cloud::Status
/// [google.spanner.admin.instance.v1.DeleteInstanceConfigRequest]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1235}
/// [google.spanner.admin.instance.v1.InstanceConfig.name]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L730}
///
// clang-format on
Status DeleteInstanceConfig(
google::spanner::admin::instance::v1::DeleteInstanceConfigRequest const&
request,
Options opts = {});
// clang-format off
///
/// Lists the user-managed instance configuration [long-running
/// operations][google.longrunning.Operation] in the given project. An instance
/// configuration operation has a name of the form
/// `projects/<project>/instanceConfigs/<instance_config>/operations/<operation>`.
/// The long-running operation
/// [metadata][google.longrunning.Operation.metadata] field type
/// `metadata.type_url` describes the type of the metadata. Operations returned
/// include those that have completed/failed/canceled within the last 7 days,
/// and pending operations. Operations returned are ordered by
/// `operation.metadata.value.start_time` in descending order starting
/// from the most recently started operation.
///
/// @param parent Required. The project of the instance configuration operations.
/// Values are of the form `projects/<project>`.
/// @param opts Optional. Override the class-level options, such as retry and
/// backoff policies.
/// @return a [StreamRange](@ref google::cloud::StreamRange)
/// to iterate of the results. See the documentation of this type for
/// details. In brief, this class has `begin()` and `end()` member
/// functions returning a iterator class meeting the
/// [input iterator requirements]. The value type for this iterator is a
/// [`StatusOr`] as the iteration may fail even after some values are
/// retrieved successfully, for example, if there is a network disconnect.
/// An empty set of results does not indicate an error, it indicates
/// that there are no resources meeting the request criteria.
/// On a successful iteration the `StatusOr<T>` contains elements of type
/// [google.longrunning.Operation], or rather,
/// the C++ class generated by Protobuf from that type. Please consult the
/// Protobuf documentation for details on the [Protobuf mapping rules].
///
/// [Protobuf mapping rules]: https://protobuf.dev/reference/cpp/cpp-generated/
/// [input iterator requirements]: https://en.cppreference.com/w/cpp/named_req/InputIterator
/// [`std::string`]: https://en.cppreference.com/w/cpp/string/basic_string
/// [`future`]: @ref google::cloud::future
/// [`StatusOr`]: @ref google::cloud::StatusOr
/// [`Status`]: @ref google::cloud::Status
/// [google.longrunning.Operation]: @googleapis_reference_link{google/longrunning/operations.proto#L121}
/// [google.longrunning.Operation.metadata]: @googleapis_reference_link{google/longrunning/operations.proto#L131}
/// [google.spanner.admin.instance.v1.ListInstanceConfigOperationsRequest]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1262}
///
// clang-format on
StreamRange<google::longrunning::Operation> ListInstanceConfigOperations(
std::string const& parent, Options opts = {});
// clang-format off
///
/// Lists the user-managed instance configuration [long-running
/// operations][google.longrunning.Operation] in the given project. An instance
/// configuration operation has a name of the form
/// `projects/<project>/instanceConfigs/<instance_config>/operations/<operation>`.
/// The long-running operation
/// [metadata][google.longrunning.Operation.metadata] field type
/// `metadata.type_url` describes the type of the metadata. Operations returned
/// include those that have completed/failed/canceled within the last 7 days,
/// and pending operations. Operations returned are ordered by
/// `operation.metadata.value.start_time` in descending order starting
/// from the most recently started operation.
///
/// @param request Unary RPCs, such as the one wrapped by this
/// function, receive a single `request` proto message which includes all
/// the inputs for the RPC. In this case, the proto message is a
/// [google.spanner.admin.instance.v1.ListInstanceConfigOperationsRequest].
/// Proto messages are converted to C++ classes by Protobuf, using the
/// [Protobuf mapping rules].
/// @param opts Optional. Override the class-level options, such as retry and
/// backoff policies.
/// @return a [StreamRange](@ref google::cloud::StreamRange)
/// to iterate of the results. See the documentation of this type for
/// details. In brief, this class has `begin()` and `end()` member
/// functions returning a iterator class meeting the
/// [input iterator requirements]. The value type for this iterator is a
/// [`StatusOr`] as the iteration may fail even after some values are
/// retrieved successfully, for example, if there is a network disconnect.
/// An empty set of results does not indicate an error, it indicates
/// that there are no resources meeting the request criteria.
/// On a successful iteration the `StatusOr<T>` contains elements of type
/// [google.longrunning.Operation], or rather,
/// the C++ class generated by Protobuf from that type. Please consult the
/// Protobuf documentation for details on the [Protobuf mapping rules].
///
/// [Protobuf mapping rules]: https://protobuf.dev/reference/cpp/cpp-generated/
/// [input iterator requirements]: https://en.cppreference.com/w/cpp/named_req/InputIterator
/// [`std::string`]: https://en.cppreference.com/w/cpp/string/basic_string
/// [`future`]: @ref google::cloud::future
/// [`StatusOr`]: @ref google::cloud::StatusOr
/// [`Status`]: @ref google::cloud::Status
/// [google.longrunning.Operation]: @googleapis_reference_link{google/longrunning/operations.proto#L121}
/// [google.longrunning.Operation.metadata]: @googleapis_reference_link{google/longrunning/operations.proto#L131}
/// [google.spanner.admin.instance.v1.ListInstanceConfigOperationsRequest]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1262}
///
// clang-format on
StreamRange<google::longrunning::Operation> ListInstanceConfigOperations(
google::spanner::admin::instance::v1::ListInstanceConfigOperationsRequest
request,
Options opts = {});
// clang-format off
///
/// Lists all instances in the given project.
///
/// @param parent Required. The name of the project for which a list of instances is
/// requested. Values are of the form `projects/<project>`.
/// @param opts Optional. Override the class-level options, such as retry and
/// backoff policies.
/// @return a [StreamRange](@ref google::cloud::StreamRange)
/// to iterate of the results. See the documentation of this type for
/// details. In brief, this class has `begin()` and `end()` member
/// functions returning a iterator class meeting the
/// [input iterator requirements]. The value type for this iterator is a
/// [`StatusOr`] as the iteration may fail even after some values are
/// retrieved successfully, for example, if there is a network disconnect.
/// An empty set of results does not indicate an error, it indicates
/// that there are no resources meeting the request criteria.
/// On a successful iteration the `StatusOr<T>` contains elements of type
/// [google.spanner.admin.instance.v1.Instance], or rather,
/// the C++ class generated by Protobuf from that type. Please consult the
/// Protobuf documentation for details on the [Protobuf mapping rules].
///
/// [Protobuf mapping rules]: https://protobuf.dev/reference/cpp/cpp-generated/
/// [input iterator requirements]: https://en.cppreference.com/w/cpp/named_req/InputIterator
/// [`std::string`]: https://en.cppreference.com/w/cpp/string/basic_string
/// [`future`]: @ref google::cloud::future
/// [`StatusOr`]: @ref google::cloud::StatusOr
/// [`Status`]: @ref google::cloud::Status
/// [google.spanner.admin.instance.v1.Instance]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L938}
/// [google.spanner.admin.instance.v1.ListInstancesRequest]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1388}
///
// clang-format on
StreamRange<google::spanner::admin::instance::v1::Instance> ListInstances(
std::string const& parent, Options opts = {});
// clang-format off
///
/// Lists all instances in the given project.
///
/// @param request Unary RPCs, such as the one wrapped by this
/// function, receive a single `request` proto message which includes all
/// the inputs for the RPC. In this case, the proto message is a
/// [google.spanner.admin.instance.v1.ListInstancesRequest].
/// Proto messages are converted to C++ classes by Protobuf, using the
/// [Protobuf mapping rules].
/// @param opts Optional. Override the class-level options, such as retry and
/// backoff policies.
/// @return a [StreamRange](@ref google::cloud::StreamRange)
/// to iterate of the results. See the documentation of this type for
/// details. In brief, this class has `begin()` and `end()` member
/// functions returning a iterator class meeting the
/// [input iterator requirements]. The value type for this iterator is a
/// [`StatusOr`] as the iteration may fail even after some values are
/// retrieved successfully, for example, if there is a network disconnect.
/// An empty set of results does not indicate an error, it indicates
/// that there are no resources meeting the request criteria.
/// On a successful iteration the `StatusOr<T>` contains elements of type
/// [google.spanner.admin.instance.v1.Instance], or rather,
/// the C++ class generated by Protobuf from that type. Please consult the
/// Protobuf documentation for details on the [Protobuf mapping rules].
///
/// [Protobuf mapping rules]: https://protobuf.dev/reference/cpp/cpp-generated/
/// [input iterator requirements]: https://en.cppreference.com/w/cpp/named_req/InputIterator
/// [`std::string`]: https://en.cppreference.com/w/cpp/string/basic_string
/// [`future`]: @ref google::cloud::future
/// [`StatusOr`]: @ref google::cloud::StatusOr
/// [`Status`]: @ref google::cloud::Status
/// [google.spanner.admin.instance.v1.Instance]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L938}
/// [google.spanner.admin.instance.v1.ListInstancesRequest]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1388}
///
// clang-format on
StreamRange<google::spanner::admin::instance::v1::Instance> ListInstances(
google::spanner::admin::instance::v1::ListInstancesRequest request,
Options opts = {});
// clang-format off
///
/// Lists all instance partitions for the given instance.
///
/// @param parent Required. The instance whose instance partitions should be listed. Values
/// are of the form `projects/<project>/instances/<instance>`.
/// @param opts Optional. Override the class-level options, such as retry and
/// backoff policies.
/// @return a [StreamRange](@ref google::cloud::StreamRange)
/// to iterate of the results. See the documentation of this type for
/// details. In brief, this class has `begin()` and `end()` member
/// functions returning a iterator class meeting the
/// [input iterator requirements]. The value type for this iterator is a
/// [`StatusOr`] as the iteration may fail even after some values are
/// retrieved successfully, for example, if there is a network disconnect.
/// An empty set of results does not indicate an error, it indicates
/// that there are no resources meeting the request criteria.
/// On a successful iteration the `StatusOr<T>` contains elements of type
/// [google.spanner.admin.instance.v1.InstancePartition], or rather,
/// the C++ class generated by Protobuf from that type. Please consult the
/// Protobuf documentation for details on the [Protobuf mapping rules].
///
/// [Protobuf mapping rules]: https://protobuf.dev/reference/cpp/cpp-generated/
/// [input iterator requirements]: https://en.cppreference.com/w/cpp/named_req/InputIterator
/// [`std::string`]: https://en.cppreference.com/w/cpp/string/basic_string
/// [`future`]: @ref google::cloud::future
/// [`StatusOr`]: @ref google::cloud::StatusOr
/// [`Status`]: @ref google::cloud::Status
/// [google.spanner.admin.instance.v1.InstancePartition]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1565}
/// [google.spanner.admin.instance.v1.ListInstancePartitionsRequest]: @googleapis_reference_link{google/spanner/admin/instance/v1/spanner_instance_admin.proto#L1794}
///
// clang-format on
StreamRange<google::spanner::admin::instance::v1::InstancePartition>
ListInstancePartitions(std::string const& parent, Options opts = {});
// clang-format off
///
/// Lists all instance partitions for the given instance.
///
/// @param request Unary RPCs, such as the one wrapped by this
/// function, receive a single `request` proto message which includes all
/// the inputs for the RPC. In this case, the proto message is a
/// [google.spanner.admin.instance.v1.ListInstancePartitionsRequest].
/// Proto messages are converted to C++ classes by Protobuf, using the
/// [Protobuf mapping rules].
/// @param opts Optional. Override the class-level options, such as retry and
/// backoff policies.
/// @return a [StreamRange](@ref google::cloud::StreamRange)
/// to iterate of the results. See the documentation of this type for
/// details. In brief, this class has `begin()` and `end()` member
/// functions returning a iterator class meeting the