-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
instance_admin_client.go
executable file
·3390 lines (3039 loc) · 123 KB
/
instance_admin_client.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
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 2024 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.
// Code generated by protoc-gen-go_gapic. DO NOT EDIT.
package instance
import (
"bytes"
"context"
"fmt"
"io"
"math"
"net/http"
"net/url"
"time"
iampb "cloud.google.com/go/iam/apiv1/iampb"
"cloud.google.com/go/longrunning"
lroauto "cloud.google.com/go/longrunning/autogen"
longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb"
instancepb "cloud.google.com/go/spanner/admin/instance/apiv1/instancepb"
gax "github.com/googleapis/gax-go/v2"
"google.golang.org/api/googleapi"
"google.golang.org/api/iterator"
"google.golang.org/api/option"
"google.golang.org/api/option/internaloption"
gtransport "google.golang.org/api/transport/grpc"
httptransport "google.golang.org/api/transport/http"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/protobuf/encoding/protojson"
"google.golang.org/protobuf/proto"
)
var newInstanceAdminClientHook clientHook
// InstanceAdminCallOptions contains the retry settings for each method of InstanceAdminClient.
type InstanceAdminCallOptions struct {
ListInstanceConfigs []gax.CallOption
GetInstanceConfig []gax.CallOption
CreateInstanceConfig []gax.CallOption
UpdateInstanceConfig []gax.CallOption
DeleteInstanceConfig []gax.CallOption
ListInstanceConfigOperations []gax.CallOption
ListInstances []gax.CallOption
ListInstancePartitions []gax.CallOption
GetInstance []gax.CallOption
CreateInstance []gax.CallOption
UpdateInstance []gax.CallOption
DeleteInstance []gax.CallOption
SetIamPolicy []gax.CallOption
GetIamPolicy []gax.CallOption
TestIamPermissions []gax.CallOption
GetInstancePartition []gax.CallOption
CreateInstancePartition []gax.CallOption
DeleteInstancePartition []gax.CallOption
UpdateInstancePartition []gax.CallOption
ListInstancePartitionOperations []gax.CallOption
}
func defaultInstanceAdminGRPCClientOptions() []option.ClientOption {
return []option.ClientOption{
internaloption.WithDefaultEndpoint("spanner.googleapis.com:443"),
internaloption.WithDefaultEndpointTemplate("spanner.UNIVERSE_DOMAIN:443"),
internaloption.WithDefaultMTLSEndpoint("spanner.mtls.googleapis.com:443"),
internaloption.WithDefaultUniverseDomain("googleapis.com"),
internaloption.WithDefaultAudience("https://spanner.googleapis.com/"),
internaloption.WithDefaultScopes(DefaultAuthScopes()...),
internaloption.EnableJwtWithScope(),
option.WithGRPCDialOption(grpc.WithDefaultCallOptions(
grpc.MaxCallRecvMsgSize(math.MaxInt32))),
}
}
func defaultInstanceAdminCallOptions() *InstanceAdminCallOptions {
return &InstanceAdminCallOptions{
ListInstanceConfigs: []gax.CallOption{
gax.WithTimeout(3600000 * time.Millisecond),
gax.WithRetry(func() gax.Retryer {
return gax.OnCodes([]codes.Code{
codes.Unavailable,
codes.DeadlineExceeded,
}, gax.Backoff{
Initial: 1000 * time.Millisecond,
Max: 32000 * time.Millisecond,
Multiplier: 1.30,
})
}),
},
GetInstanceConfig: []gax.CallOption{
gax.WithTimeout(3600000 * time.Millisecond),
gax.WithRetry(func() gax.Retryer {
return gax.OnCodes([]codes.Code{
codes.Unavailable,
codes.DeadlineExceeded,
}, gax.Backoff{
Initial: 1000 * time.Millisecond,
Max: 32000 * time.Millisecond,
Multiplier: 1.30,
})
}),
},
CreateInstanceConfig: []gax.CallOption{},
UpdateInstanceConfig: []gax.CallOption{},
DeleteInstanceConfig: []gax.CallOption{},
ListInstanceConfigOperations: []gax.CallOption{},
ListInstances: []gax.CallOption{
gax.WithTimeout(3600000 * time.Millisecond),
gax.WithRetry(func() gax.Retryer {
return gax.OnCodes([]codes.Code{
codes.Unavailable,
codes.DeadlineExceeded,
}, gax.Backoff{
Initial: 1000 * time.Millisecond,
Max: 32000 * time.Millisecond,
Multiplier: 1.30,
})
}),
},
ListInstancePartitions: []gax.CallOption{},
GetInstance: []gax.CallOption{
gax.WithTimeout(3600000 * time.Millisecond),
gax.WithRetry(func() gax.Retryer {
return gax.OnCodes([]codes.Code{
codes.Unavailable,
codes.DeadlineExceeded,
}, gax.Backoff{
Initial: 1000 * time.Millisecond,
Max: 32000 * time.Millisecond,
Multiplier: 1.30,
})
}),
},
CreateInstance: []gax.CallOption{
gax.WithTimeout(3600000 * time.Millisecond),
},
UpdateInstance: []gax.CallOption{
gax.WithTimeout(3600000 * time.Millisecond),
},
DeleteInstance: []gax.CallOption{
gax.WithTimeout(3600000 * time.Millisecond),
gax.WithRetry(func() gax.Retryer {
return gax.OnCodes([]codes.Code{
codes.Unavailable,
codes.DeadlineExceeded,
}, gax.Backoff{
Initial: 1000 * time.Millisecond,
Max: 32000 * time.Millisecond,
Multiplier: 1.30,
})
}),
},
SetIamPolicy: []gax.CallOption{
gax.WithTimeout(30000 * time.Millisecond),
},
GetIamPolicy: []gax.CallOption{
gax.WithTimeout(30000 * time.Millisecond),
gax.WithRetry(func() gax.Retryer {
return gax.OnCodes([]codes.Code{
codes.Unavailable,
codes.DeadlineExceeded,
}, gax.Backoff{
Initial: 1000 * time.Millisecond,
Max: 32000 * time.Millisecond,
Multiplier: 1.30,
})
}),
},
TestIamPermissions: []gax.CallOption{
gax.WithTimeout(30000 * time.Millisecond),
},
GetInstancePartition: []gax.CallOption{},
CreateInstancePartition: []gax.CallOption{},
DeleteInstancePartition: []gax.CallOption{},
UpdateInstancePartition: []gax.CallOption{},
ListInstancePartitionOperations: []gax.CallOption{},
}
}
func defaultInstanceAdminRESTCallOptions() *InstanceAdminCallOptions {
return &InstanceAdminCallOptions{
ListInstanceConfigs: []gax.CallOption{
gax.WithTimeout(3600000 * time.Millisecond),
gax.WithRetry(func() gax.Retryer {
return gax.OnHTTPCodes(gax.Backoff{
Initial: 1000 * time.Millisecond,
Max: 32000 * time.Millisecond,
Multiplier: 1.30,
},
http.StatusServiceUnavailable,
http.StatusGatewayTimeout)
}),
},
GetInstanceConfig: []gax.CallOption{
gax.WithTimeout(3600000 * time.Millisecond),
gax.WithRetry(func() gax.Retryer {
return gax.OnHTTPCodes(gax.Backoff{
Initial: 1000 * time.Millisecond,
Max: 32000 * time.Millisecond,
Multiplier: 1.30,
},
http.StatusServiceUnavailable,
http.StatusGatewayTimeout)
}),
},
CreateInstanceConfig: []gax.CallOption{},
UpdateInstanceConfig: []gax.CallOption{},
DeleteInstanceConfig: []gax.CallOption{},
ListInstanceConfigOperations: []gax.CallOption{},
ListInstances: []gax.CallOption{
gax.WithTimeout(3600000 * time.Millisecond),
gax.WithRetry(func() gax.Retryer {
return gax.OnHTTPCodes(gax.Backoff{
Initial: 1000 * time.Millisecond,
Max: 32000 * time.Millisecond,
Multiplier: 1.30,
},
http.StatusServiceUnavailable,
http.StatusGatewayTimeout)
}),
},
ListInstancePartitions: []gax.CallOption{},
GetInstance: []gax.CallOption{
gax.WithTimeout(3600000 * time.Millisecond),
gax.WithRetry(func() gax.Retryer {
return gax.OnHTTPCodes(gax.Backoff{
Initial: 1000 * time.Millisecond,
Max: 32000 * time.Millisecond,
Multiplier: 1.30,
},
http.StatusServiceUnavailable,
http.StatusGatewayTimeout)
}),
},
CreateInstance: []gax.CallOption{
gax.WithTimeout(3600000 * time.Millisecond),
},
UpdateInstance: []gax.CallOption{
gax.WithTimeout(3600000 * time.Millisecond),
},
DeleteInstance: []gax.CallOption{
gax.WithTimeout(3600000 * time.Millisecond),
gax.WithRetry(func() gax.Retryer {
return gax.OnHTTPCodes(gax.Backoff{
Initial: 1000 * time.Millisecond,
Max: 32000 * time.Millisecond,
Multiplier: 1.30,
},
http.StatusServiceUnavailable,
http.StatusGatewayTimeout)
}),
},
SetIamPolicy: []gax.CallOption{
gax.WithTimeout(30000 * time.Millisecond),
},
GetIamPolicy: []gax.CallOption{
gax.WithTimeout(30000 * time.Millisecond),
gax.WithRetry(func() gax.Retryer {
return gax.OnHTTPCodes(gax.Backoff{
Initial: 1000 * time.Millisecond,
Max: 32000 * time.Millisecond,
Multiplier: 1.30,
},
http.StatusServiceUnavailable,
http.StatusGatewayTimeout)
}),
},
TestIamPermissions: []gax.CallOption{
gax.WithTimeout(30000 * time.Millisecond),
},
GetInstancePartition: []gax.CallOption{},
CreateInstancePartition: []gax.CallOption{},
DeleteInstancePartition: []gax.CallOption{},
UpdateInstancePartition: []gax.CallOption{},
ListInstancePartitionOperations: []gax.CallOption{},
}
}
// internalInstanceAdminClient is an interface that defines the methods available from Cloud Spanner Instance Admin API.
type internalInstanceAdminClient interface {
Close() error
setGoogleClientInfo(...string)
Connection() *grpc.ClientConn
ListInstanceConfigs(context.Context, *instancepb.ListInstanceConfigsRequest, ...gax.CallOption) *InstanceConfigIterator
GetInstanceConfig(context.Context, *instancepb.GetInstanceConfigRequest, ...gax.CallOption) (*instancepb.InstanceConfig, error)
CreateInstanceConfig(context.Context, *instancepb.CreateInstanceConfigRequest, ...gax.CallOption) (*CreateInstanceConfigOperation, error)
CreateInstanceConfigOperation(name string) *CreateInstanceConfigOperation
UpdateInstanceConfig(context.Context, *instancepb.UpdateInstanceConfigRequest, ...gax.CallOption) (*UpdateInstanceConfigOperation, error)
UpdateInstanceConfigOperation(name string) *UpdateInstanceConfigOperation
DeleteInstanceConfig(context.Context, *instancepb.DeleteInstanceConfigRequest, ...gax.CallOption) error
ListInstanceConfigOperations(context.Context, *instancepb.ListInstanceConfigOperationsRequest, ...gax.CallOption) *OperationIterator
ListInstances(context.Context, *instancepb.ListInstancesRequest, ...gax.CallOption) *InstanceIterator
ListInstancePartitions(context.Context, *instancepb.ListInstancePartitionsRequest, ...gax.CallOption) *InstancePartitionIterator
GetInstance(context.Context, *instancepb.GetInstanceRequest, ...gax.CallOption) (*instancepb.Instance, error)
CreateInstance(context.Context, *instancepb.CreateInstanceRequest, ...gax.CallOption) (*CreateInstanceOperation, error)
CreateInstanceOperation(name string) *CreateInstanceOperation
UpdateInstance(context.Context, *instancepb.UpdateInstanceRequest, ...gax.CallOption) (*UpdateInstanceOperation, error)
UpdateInstanceOperation(name string) *UpdateInstanceOperation
DeleteInstance(context.Context, *instancepb.DeleteInstanceRequest, ...gax.CallOption) error
SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest, ...gax.CallOption) (*iampb.Policy, error)
GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest, ...gax.CallOption) (*iampb.Policy, error)
TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest, ...gax.CallOption) (*iampb.TestIamPermissionsResponse, error)
GetInstancePartition(context.Context, *instancepb.GetInstancePartitionRequest, ...gax.CallOption) (*instancepb.InstancePartition, error)
CreateInstancePartition(context.Context, *instancepb.CreateInstancePartitionRequest, ...gax.CallOption) (*CreateInstancePartitionOperation, error)
CreateInstancePartitionOperation(name string) *CreateInstancePartitionOperation
DeleteInstancePartition(context.Context, *instancepb.DeleteInstancePartitionRequest, ...gax.CallOption) error
UpdateInstancePartition(context.Context, *instancepb.UpdateInstancePartitionRequest, ...gax.CallOption) (*UpdateInstancePartitionOperation, error)
UpdateInstancePartitionOperation(name string) *UpdateInstancePartitionOperation
ListInstancePartitionOperations(context.Context, *instancepb.ListInstancePartitionOperationsRequest, ...gax.CallOption) *OperationIterator
}
// InstanceAdminClient is a client for interacting with Cloud Spanner Instance Admin API.
// Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
//
// # 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.
type InstanceAdminClient struct {
// The internal transport-dependent client.
internalClient internalInstanceAdminClient
// The call options for this service.
CallOptions *InstanceAdminCallOptions
// LROClient is used internally to handle long-running operations.
// It is exposed so that its CallOptions can be modified if required.
// Users should not Close this client.
LROClient *lroauto.OperationsClient
}
// Wrapper methods routed to the internal client.
// Close closes the connection to the API service. The user should invoke this when
// the client is no longer required.
func (c *InstanceAdminClient) Close() error {
return c.internalClient.Close()
}
// setGoogleClientInfo sets the name and version of the application in
// the `x-goog-api-client` header passed on each request. Intended for
// use by Google-written clients.
func (c *InstanceAdminClient) setGoogleClientInfo(keyval ...string) {
c.internalClient.setGoogleClientInfo(keyval...)
}
// Connection returns a connection to the API service.
//
// Deprecated: Connections are now pooled so this method does not always
// return the same resource.
func (c *InstanceAdminClient) Connection() *grpc.ClientConn {
return c.internalClient.Connection()
}
// ListInstanceConfigs lists the supported instance configurations for a given project.
func (c *InstanceAdminClient) ListInstanceConfigs(ctx context.Context, req *instancepb.ListInstanceConfigsRequest, opts ...gax.CallOption) *InstanceConfigIterator {
return c.internalClient.ListInstanceConfigs(ctx, req, opts...)
}
// GetInstanceConfig gets information about a particular instance configuration.
func (c *InstanceAdminClient) GetInstanceConfig(ctx context.Context, req *instancepb.GetInstanceConfigRequest, opts ...gax.CallOption) (*instancepb.InstanceConfig, error) {
return c.internalClient.GetInstanceConfig(ctx, req, opts...)
}
// CreateInstanceConfig creates an instance config 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 config. The instance config name is assigned by the caller. If the
// named instance config already exists, CreateInstanceConfig returns
// ALREADY_EXISTS.
//
// Immediately after the request returns:
//
// The instance config is readable via the API, with all requested
// attributes. The instance config’s
// reconciling
// field is set to true. Its state is CREATING.
//
// While the operation is pending:
//
// Cancelling the operation renders the instance config immediately
// unreadable via the API.
//
// Except for deleting the creating resource, all other attempts to modify
// the instance config are rejected.
//
// Upon completion of the returned operation:
//
// Instances can be created using the instance configuration.
//
// The instance config’s
// 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 config. The
// metadata field type is
// CreateInstanceConfigMetadata.
// The response field type is
// InstanceConfig, if
// successful.
//
// Authorization requires spanner.instanceConfigs.create permission on
// the resource
// parent.
func (c *InstanceAdminClient) CreateInstanceConfig(ctx context.Context, req *instancepb.CreateInstanceConfigRequest, opts ...gax.CallOption) (*CreateInstanceConfigOperation, error) {
return c.internalClient.CreateInstanceConfig(ctx, req, opts...)
}
// CreateInstanceConfigOperation returns a new CreateInstanceConfigOperation from a given name.
// The name must be that of a previously created CreateInstanceConfigOperation, possibly from a different process.
func (c *InstanceAdminClient) CreateInstanceConfigOperation(name string) *CreateInstanceConfigOperation {
return c.internalClient.CreateInstanceConfigOperation(name)
}
// UpdateInstanceConfig updates an instance config. The returned
// [long-running operation][google.longrunning.Operation] can be used to track
// the progress of updating the instance. If the named instance config does
// not exist, returns NOT_FOUND.
//
// Only user managed configurations can be updated.
//
// Immediately after the request returns:
//
// The instance config’s
// reconciling
// field is set to true.
//
// While the operation is pending:
//
// Cancelling the operation sets its metadata’s
// 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 config are rejected.
//
// Reading the instance config 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 instance config’s new values are readable via the API.
//
// The instance config’s
// 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 config modification. The
// metadata field type is
// UpdateInstanceConfigMetadata.
// The response field type is
// InstanceConfig, if
// successful.
//
// Authorization requires spanner.instanceConfigs.update permission on
// the resource [name][google.spanner.admin.instance.v1.InstanceConfig.name (at http://google.spanner.admin.instance.v1.InstanceConfig.name)].
func (c *InstanceAdminClient) UpdateInstanceConfig(ctx context.Context, req *instancepb.UpdateInstanceConfigRequest, opts ...gax.CallOption) (*UpdateInstanceConfigOperation, error) {
return c.internalClient.UpdateInstanceConfig(ctx, req, opts...)
}
// UpdateInstanceConfigOperation returns a new UpdateInstanceConfigOperation from a given name.
// The name must be that of a previously created UpdateInstanceConfigOperation, possibly from a different process.
func (c *InstanceAdminClient) UpdateInstanceConfigOperation(name string) *UpdateInstanceConfigOperation {
return c.internalClient.UpdateInstanceConfigOperation(name)
}
// DeleteInstanceConfig deletes the instance config. Deletion is only allowed when no
// instances are using the configuration. If any instances are using
// the config, 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 (at http://google.spanner.admin.instance.v1.InstanceConfig.name)].
func (c *InstanceAdminClient) DeleteInstanceConfig(ctx context.Context, req *instancepb.DeleteInstanceConfigRequest, opts ...gax.CallOption) error {
return c.internalClient.DeleteInstanceConfig(ctx, req, opts...)
}
// ListInstanceConfigOperations lists the user-managed instance config [long-running
// operations][google.longrunning.Operation] in the given project. An instance
// config operation has a name of the form
// projects/<project>/instanceConfigs/<instance_config>/operations/<operation>.
// The long-running 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.
func (c *InstanceAdminClient) ListInstanceConfigOperations(ctx context.Context, req *instancepb.ListInstanceConfigOperationsRequest, opts ...gax.CallOption) *OperationIterator {
return c.internalClient.ListInstanceConfigOperations(ctx, req, opts...)
}
// ListInstances lists all instances in the given project.
func (c *InstanceAdminClient) ListInstances(ctx context.Context, req *instancepb.ListInstancesRequest, opts ...gax.CallOption) *InstanceIterator {
return c.internalClient.ListInstances(ctx, req, opts...)
}
// ListInstancePartitions lists all instance partitions for the given instance.
func (c *InstanceAdminClient) ListInstancePartitions(ctx context.Context, req *instancepb.ListInstancePartitionsRequest, opts ...gax.CallOption) *InstancePartitionIterator {
return c.internalClient.ListInstancePartitions(ctx, req, opts...)
}
// GetInstance gets information about a particular instance.
func (c *InstanceAdminClient) GetInstance(ctx context.Context, req *instancepb.GetInstanceRequest, opts ...gax.CallOption) (*instancepb.Instance, error) {
return c.internalClient.GetInstance(ctx, req, opts...)
}
// CreateInstance creates an instance and begins preparing it to begin serving. The
// returned [long-running operation][google.longrunning.Operation]
// can be used to track the progress of preparing the new
// instance. The instance name is assigned by the caller. If the
// named instance already exists, CreateInstance returns
// ALREADY_EXISTS.
//
// Immediately upon completion of this request:
//
// The instance is readable via the API, with all requested attributes
// but no allocated resources. Its state is CREATING.
//
// Until completion of the returned operation:
//
// Cancelling the operation renders the instance immediately unreadable
// via the API.
//
// The instance can be deleted.
//
// All other attempts to modify the instance are rejected.
//
// Upon completion of the returned operation:
//
// Billing for all successfully-allocated resources begins (some types
// may have lower than the requested levels).
//
// Databases can be created in the instance.
//
// The instance’s allocated resource levels are readable via the API.
//
// The instance’s state becomes READY.
//
// The returned [long-running operation][google.longrunning.Operation] will
// have a name of the format <instance_name>/operations/<operation_id> and
// can be used to track creation of the instance. The
// metadata field type is
// CreateInstanceMetadata.
// The response field type is
// Instance, if successful.
func (c *InstanceAdminClient) CreateInstance(ctx context.Context, req *instancepb.CreateInstanceRequest, opts ...gax.CallOption) (*CreateInstanceOperation, error) {
return c.internalClient.CreateInstance(ctx, req, opts...)
}
// CreateInstanceOperation returns a new CreateInstanceOperation from a given name.
// The name must be that of a previously created CreateInstanceOperation, possibly from a different process.
func (c *InstanceAdminClient) CreateInstanceOperation(name string) *CreateInstanceOperation {
return c.internalClient.CreateInstanceOperation(name)
}
// UpdateInstance updates an instance, and begins allocating or releasing resources
// as requested. The returned [long-running
// operation][google.longrunning.Operation] can be used to track the
// progress of updating the instance. If the named instance does not
// exist, returns NOT_FOUND.
//
// Immediately upon completion of this request:
//
// For resource types for which a decrease in the instance’s allocation
// has been requested, billing is based on the newly-requested level.
//
// Until completion of the returned operation:
//
// Cancelling the operation sets its metadata’s
// cancel_time,
// and begins restoring resources to their pre-request values. The
// operation is guaranteed to succeed at undoing all resource changes,
// after which point it terminates with a CANCELLED status.
//
// All other attempts to modify the instance are rejected.
//
// Reading the instance via the API continues to give the pre-request
// resource levels.
//
// Upon completion of the returned operation:
//
// Billing begins for all successfully-allocated resources (some types
// may have lower than the requested levels).
//
// All newly-reserved resources are available for serving the instance’s
// tables.
//
// The instance’s new resource levels are readable via the API.
//
// The returned [long-running operation][google.longrunning.Operation] will
// have a name of the format <instance_name>/operations/<operation_id> and
// can be used to track the instance modification. The
// metadata field type is
// UpdateInstanceMetadata.
// The response field type is
// Instance, if successful.
//
// Authorization requires spanner.instances.update permission on
// the resource [name][google.spanner.admin.instance.v1.Instance.name (at http://google.spanner.admin.instance.v1.Instance.name)].
func (c *InstanceAdminClient) UpdateInstance(ctx context.Context, req *instancepb.UpdateInstanceRequest, opts ...gax.CallOption) (*UpdateInstanceOperation, error) {
return c.internalClient.UpdateInstance(ctx, req, opts...)
}
// UpdateInstanceOperation returns a new UpdateInstanceOperation from a given name.
// The name must be that of a previously created UpdateInstanceOperation, possibly from a different process.
func (c *InstanceAdminClient) UpdateInstanceOperation(name string) *UpdateInstanceOperation {
return c.internalClient.UpdateInstanceOperation(name)
}
// DeleteInstance deletes an instance.
//
// Immediately upon completion of the request:
//
// Billing ceases for all of the instance’s reserved resources.
//
// Soon afterward:
//
// The instance and all of its databases immediately and
// irrevocably disappear from the API. All data in the databases
// is permanently deleted.
func (c *InstanceAdminClient) DeleteInstance(ctx context.Context, req *instancepb.DeleteInstanceRequest, opts ...gax.CallOption) error {
return c.internalClient.DeleteInstance(ctx, req, opts...)
}
// SetIamPolicy sets the access control policy on an instance resource. Replaces any
// existing policy.
//
// Authorization requires spanner.instances.setIamPolicy on
// resource.
func (c *InstanceAdminClient) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error) {
return c.internalClient.SetIamPolicy(ctx, req, opts...)
}
// GetIamPolicy gets the access control policy for an instance resource. Returns an empty
// policy if an instance exists but does not have a policy set.
//
// Authorization requires spanner.instances.getIamPolicy on
// resource.
func (c *InstanceAdminClient) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error) {
return c.internalClient.GetIamPolicy(ctx, req, opts...)
}
// TestIamPermissions returns permissions that the caller has on the specified instance resource.
//
// Attempting this RPC on a non-existent Cloud Spanner instance resource will
// result in a NOT_FOUND error if the user has spanner.instances.list
// permission on the containing Google Cloud Project. Otherwise returns an
// empty set of permissions.
func (c *InstanceAdminClient) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, opts ...gax.CallOption) (*iampb.TestIamPermissionsResponse, error) {
return c.internalClient.TestIamPermissions(ctx, req, opts...)
}
// GetInstancePartition gets information about a particular instance partition.
func (c *InstanceAdminClient) GetInstancePartition(ctx context.Context, req *instancepb.GetInstancePartitionRequest, opts ...gax.CallOption) (*instancepb.InstancePartition, error) {
return c.internalClient.GetInstancePartition(ctx, req, opts...)
}
// CreateInstancePartition creates an instance partition 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 partition.
// The instance partition name is assigned by the caller. If the named
// instance partition already exists, CreateInstancePartition returns
// ALREADY_EXISTS.
//
// Immediately upon completion of this request:
//
// The instance partition is readable via the API, with all requested
// attributes but no allocated resources. Its state is CREATING.
//
// Until completion of the returned operation:
//
// Cancelling the operation renders the instance partition immediately
// unreadable via the API.
//
// The instance partition can be deleted.
//
// All other attempts to modify the instance partition are rejected.
//
// Upon completion of the returned operation:
//
// Billing for all successfully-allocated resources begins (some types
// may have lower than the requested levels).
//
// Databases can start using this instance partition.
//
// The instance partition’s allocated resource levels are readable via the
// API.
//
// The instance partition’s state becomes READY.
//
// The returned [long-running operation][google.longrunning.Operation] will
// have a name of the format
// <instance_partition_name>/operations/<operation_id> and can be used to
// track creation of the instance partition. The
// metadata field type is
// CreateInstancePartitionMetadata.
// The response field type is
// InstancePartition, if
// successful.
func (c *InstanceAdminClient) CreateInstancePartition(ctx context.Context, req *instancepb.CreateInstancePartitionRequest, opts ...gax.CallOption) (*CreateInstancePartitionOperation, error) {
return c.internalClient.CreateInstancePartition(ctx, req, opts...)
}
// CreateInstancePartitionOperation returns a new CreateInstancePartitionOperation from a given name.
// The name must be that of a previously created CreateInstancePartitionOperation, possibly from a different process.
func (c *InstanceAdminClient) CreateInstancePartitionOperation(name string) *CreateInstancePartitionOperation {
return c.internalClient.CreateInstancePartitionOperation(name)
}
// DeleteInstancePartition deletes an existing instance partition. Requires that the
// instance partition is not used by any database or backup and is not the
// default instance partition of an instance.
//
// Authorization requires spanner.instancePartitions.delete permission on
// the resource
// [name][google.spanner.admin.instance.v1.InstancePartition.name (at http://google.spanner.admin.instance.v1.InstancePartition.name)].
func (c *InstanceAdminClient) DeleteInstancePartition(ctx context.Context, req *instancepb.DeleteInstancePartitionRequest, opts ...gax.CallOption) error {
return c.internalClient.DeleteInstancePartition(ctx, req, opts...)
}
// UpdateInstancePartition updates an instance partition, and begins allocating or releasing resources
// as requested. The returned [long-running
// operation][google.longrunning.Operation] can be used to track the
// progress of updating the instance partition. If the named instance
// partition does not exist, returns NOT_FOUND.
//
// Immediately upon completion of this request:
//
// For resource types for which a decrease in the instance partition’s
// allocation has been requested, billing is based on the newly-requested
// level.
//
// Until completion of the returned operation:
//
// Cancelling the operation sets its metadata’s
// cancel_time,
// and begins restoring resources to their pre-request values. The
// operation is guaranteed to succeed at undoing all resource changes,
// after which point it terminates with a CANCELLED status.
//
// All other attempts to modify the instance partition are rejected.
//
// Reading the instance partition via the API continues to give the
// pre-request resource levels.
//
// Upon completion of the returned operation:
//
// Billing begins for all successfully-allocated resources (some types
// may have lower than the requested levels).
//
// All newly-reserved resources are available for serving the instance
// partition’s tables.
//
// The instance partition’s new resource levels are readable via the API.
//
// The returned [long-running operation][google.longrunning.Operation] will
// have a name of the format
// <instance_partition_name>/operations/<operation_id> and can be used to
// track the instance partition modification. The
// metadata field type is
// UpdateInstancePartitionMetadata.
// The response field type is
// InstancePartition, if
// successful.
//
// Authorization requires spanner.instancePartitions.update permission on
// the resource
// [name][google.spanner.admin.instance.v1.InstancePartition.name (at http://google.spanner.admin.instance.v1.InstancePartition.name)].
func (c *InstanceAdminClient) UpdateInstancePartition(ctx context.Context, req *instancepb.UpdateInstancePartitionRequest, opts ...gax.CallOption) (*UpdateInstancePartitionOperation, error) {
return c.internalClient.UpdateInstancePartition(ctx, req, opts...)
}
// UpdateInstancePartitionOperation returns a new UpdateInstancePartitionOperation from a given name.
// The name must be that of a previously created UpdateInstancePartitionOperation, possibly from a different process.
func (c *InstanceAdminClient) UpdateInstancePartitionOperation(name string) *UpdateInstancePartitionOperation {
return c.internalClient.UpdateInstancePartitionOperation(name)
}
// ListInstancePartitionOperations lists instance partition [long-running
// operations][google.longrunning.Operation] in the given instance.
// An instance partition operation has a name of the form
// projects/<project>/instances/<instance>/instancePartitions/<instance_partition>/operations/<operation>.
// The long-running 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.
//
// Authorization requires spanner.instancePartitionOperations.list
// permission on the resource
// parent.
func (c *InstanceAdminClient) ListInstancePartitionOperations(ctx context.Context, req *instancepb.ListInstancePartitionOperationsRequest, opts ...gax.CallOption) *OperationIterator {
return c.internalClient.ListInstancePartitionOperations(ctx, req, opts...)
}
// instanceAdminGRPCClient is a client for interacting with Cloud Spanner Instance Admin API over gRPC transport.
//
// Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
type instanceAdminGRPCClient struct {
// Connection pool of gRPC connections to the service.
connPool gtransport.ConnPool
// Points back to the CallOptions field of the containing InstanceAdminClient
CallOptions **InstanceAdminCallOptions
// The gRPC API client.
instanceAdminClient instancepb.InstanceAdminClient
// LROClient is used internally to handle long-running operations.
// It is exposed so that its CallOptions can be modified if required.
// Users should not Close this client.
LROClient **lroauto.OperationsClient
// The x-goog-* metadata to be sent with each request.
xGoogHeaders []string
}
// NewInstanceAdminClient creates a new instance admin client based on gRPC.
// The returned client must be Closed when it is done being used to clean up its underlying connections.
//
// # 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.
func NewInstanceAdminClient(ctx context.Context, opts ...option.ClientOption) (*InstanceAdminClient, error) {
clientOpts := defaultInstanceAdminGRPCClientOptions()
if newInstanceAdminClientHook != nil {
hookOpts, err := newInstanceAdminClientHook(ctx, clientHookParams{})
if err != nil {
return nil, err
}
clientOpts = append(clientOpts, hookOpts...)
}
connPool, err := gtransport.DialPool(ctx, append(clientOpts, opts...)...)
if err != nil {
return nil, err
}
client := InstanceAdminClient{CallOptions: defaultInstanceAdminCallOptions()}
c := &instanceAdminGRPCClient{
connPool: connPool,
instanceAdminClient: instancepb.NewInstanceAdminClient(connPool),
CallOptions: &client.CallOptions,
}
c.setGoogleClientInfo()
client.internalClient = c
client.LROClient, err = lroauto.NewOperationsClient(ctx, gtransport.WithConnPool(connPool))
if err != nil {
// This error "should not happen", since we are just reusing old connection pool
// and never actually need to dial.
// If this does happen, we could leak connp. However, we cannot close conn:
// If the user invoked the constructor with option.WithGRPCConn,
// we would close a connection that's still in use.
// TODO: investigate error conditions.
return nil, err
}
c.LROClient = &client.LROClient
return &client, nil
}
// Connection returns a connection to the API service.
//
// Deprecated: Connections are now pooled so this method does not always
// return the same resource.
func (c *instanceAdminGRPCClient) Connection() *grpc.ClientConn {
return c.connPool.Conn()
}
// setGoogleClientInfo sets the name and version of the application in
// the `x-goog-api-client` header passed on each request. Intended for
// use by Google-written clients.
func (c *instanceAdminGRPCClient) setGoogleClientInfo(keyval ...string) {
kv := append([]string{"gl-go", gax.GoVersion}, keyval...)
kv = append(kv, "gapic", getVersionClient(), "gax", gax.Version, "grpc", grpc.Version)
c.xGoogHeaders = []string{"x-goog-api-client", gax.XGoogHeader(kv...)}
}
// Close closes the connection to the API service. The user should invoke this when
// the client is no longer required.
func (c *instanceAdminGRPCClient) Close() error {
return c.connPool.Close()
}
// Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
type instanceAdminRESTClient struct {
// The http endpoint to connect to.
endpoint string
// The http client.
httpClient *http.Client
// LROClient is used internally to handle long-running operations.
// It is exposed so that its CallOptions can be modified if required.
// Users should not Close this client.
LROClient **lroauto.OperationsClient
// The x-goog-* headers to be sent with each request.
xGoogHeaders []string
// Points back to the CallOptions field of the containing InstanceAdminClient
CallOptions **InstanceAdminCallOptions
}
// NewInstanceAdminRESTClient creates a new instance admin rest client.
//
// # 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.
func NewInstanceAdminRESTClient(ctx context.Context, opts ...option.ClientOption) (*InstanceAdminClient, error) {
clientOpts := append(defaultInstanceAdminRESTClientOptions(), opts...)
httpClient, endpoint, err := httptransport.NewClient(ctx, clientOpts...)
if err != nil {
return nil, err
}
callOpts := defaultInstanceAdminRESTCallOptions()
c := &instanceAdminRESTClient{
endpoint: endpoint,
httpClient: httpClient,
CallOptions: &callOpts,