/
DatabaseAdminClient.java
2951 lines (2809 loc) · 128 KB
/
DatabaseAdminClient.java
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 2020 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.
*/
package com.google.cloud.spanner.admin.database.v1;
import com.google.api.core.ApiFunction;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.OperationCallable;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.api.resourcenames.ResourceName;
import com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStub;
import com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.iam.v1.GetIamPolicyRequest;
import com.google.iam.v1.Policy;
import com.google.iam.v1.SetIamPolicyRequest;
import com.google.iam.v1.TestIamPermissionsRequest;
import com.google.iam.v1.TestIamPermissionsResponse;
import com.google.longrunning.Operation;
import com.google.longrunning.OperationsClient;
import com.google.protobuf.Empty;
import com.google.protobuf.FieldMask;
import com.google.spanner.admin.database.v1.Backup;
import com.google.spanner.admin.database.v1.BackupName;
import com.google.spanner.admin.database.v1.CreateBackupMetadata;
import com.google.spanner.admin.database.v1.CreateBackupRequest;
import com.google.spanner.admin.database.v1.CreateDatabaseMetadata;
import com.google.spanner.admin.database.v1.CreateDatabaseRequest;
import com.google.spanner.admin.database.v1.Database;
import com.google.spanner.admin.database.v1.DatabaseName;
import com.google.spanner.admin.database.v1.DeleteBackupRequest;
import com.google.spanner.admin.database.v1.DropDatabaseRequest;
import com.google.spanner.admin.database.v1.GetBackupRequest;
import com.google.spanner.admin.database.v1.GetDatabaseDdlRequest;
import com.google.spanner.admin.database.v1.GetDatabaseDdlResponse;
import com.google.spanner.admin.database.v1.GetDatabaseRequest;
import com.google.spanner.admin.database.v1.InstanceName;
import com.google.spanner.admin.database.v1.ListBackupOperationsRequest;
import com.google.spanner.admin.database.v1.ListBackupOperationsResponse;
import com.google.spanner.admin.database.v1.ListBackupsRequest;
import com.google.spanner.admin.database.v1.ListBackupsResponse;
import com.google.spanner.admin.database.v1.ListDatabaseOperationsRequest;
import com.google.spanner.admin.database.v1.ListDatabaseOperationsResponse;
import com.google.spanner.admin.database.v1.ListDatabasesRequest;
import com.google.spanner.admin.database.v1.ListDatabasesResponse;
import com.google.spanner.admin.database.v1.RestoreDatabaseMetadata;
import com.google.spanner.admin.database.v1.RestoreDatabaseRequest;
import com.google.spanner.admin.database.v1.UpdateBackupRequest;
import com.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata;
import com.google.spanner.admin.database.v1.UpdateDatabaseDdlRequest;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Cloud Spanner Database Admin API
*
* <p>The Cloud Spanner Database Admin API can be used to create, drop, and list databases. It also
* enables updating the schema of pre-existing databases. It can be also used to create, delete and
* list backups for a database and to restore from an existing backup.
*
* <p>This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* DatabaseName name = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
* Database response = databaseAdminClient.getDatabase(name);
* }
* }</pre>
*
* <p>Note: close() needs to be called on the DatabaseAdminClient object to clean up resources such
* as threads. In the example above, try-with-resources is used, which automatically calls close().
*
* <p>The surface of this class includes several types of Java methods for each of the API's
* methods:
*
* <ol>
* <li>A "flattened" method. With this type of method, the fields of the request type have been
* converted into function parameters. It may be the case that not all fields are available as
* parameters, and not every API method will have a flattened method entry point.
* <li>A "request object" method. This type of method only takes one parameter, a request object,
* which must be constructed before the call. Not every API method will have a request object
* method.
* <li>A "callable" method. This type of method takes no parameters and returns an immutable API
* callable object, which can be used to initiate calls to the service.
* </ol>
*
* <p>See the individual methods for example code.
*
* <p>Many parameters require resource names to be formatted in a particular way. To assist with
* these names, this class includes a format method for each type of name, and additionally a parse
* method to extract the individual identifiers contained within names that are returned.
*
* <p>This class can be customized by passing in a custom instance of DatabaseAdminSettings to
* create(). For example:
*
* <p>To customize credentials:
*
* <pre>{@code
* DatabaseAdminSettings databaseAdminSettings =
* DatabaseAdminSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create(databaseAdminSettings);
* }</pre>
*
* <p>To customize the endpoint:
*
* <pre>{@code
* DatabaseAdminSettings databaseAdminSettings =
* DatabaseAdminSettings.newBuilder().setEndpoint(myEndpoint).build();
* DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create(databaseAdminSettings);
* }</pre>
*
* <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class DatabaseAdminClient implements BackgroundResource {
private final DatabaseAdminSettings settings;
private final DatabaseAdminStub stub;
private final OperationsClient operationsClient;
/** Constructs an instance of DatabaseAdminClient with default settings. */
public static final DatabaseAdminClient create() throws IOException {
return create(DatabaseAdminSettings.newBuilder().build());
}
/**
* Constructs an instance of DatabaseAdminClient, using the given settings. The channels are
* created based on the settings passed in, or defaults for any settings that are not set.
*/
public static final DatabaseAdminClient create(DatabaseAdminSettings settings)
throws IOException {
return new DatabaseAdminClient(settings);
}
/**
* Constructs an instance of DatabaseAdminClient, using the given stub for making calls. This is
* for advanced usage - prefer using create(DatabaseAdminSettings).
*/
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final DatabaseAdminClient create(DatabaseAdminStub stub) {
return new DatabaseAdminClient(stub);
}
/**
* Constructs an instance of DatabaseAdminClient, using the given settings. This is protected so
* that it is easy to make a subclass, but otherwise, the static factory methods should be
* preferred.
*/
protected DatabaseAdminClient(DatabaseAdminSettings settings) throws IOException {
this.settings = settings;
this.stub = ((DatabaseAdminStubSettings) settings.getStubSettings()).createStub();
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected DatabaseAdminClient(DatabaseAdminStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
}
public final DatabaseAdminSettings getSettings() {
return settings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public DatabaseAdminStub getStub() {
return stub;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
public final OperationsClient getOperationsClient() {
return operationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists Cloud Spanner databases.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
* for (Database element : databaseAdminClient.listDatabases(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* @param parent Required. The instance whose databases should be listed. Values are of the form
* `projects/<project>/instances/<instance>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListDatabasesPagedResponse listDatabases(InstanceName parent) {
ListDatabasesRequest request =
ListDatabasesRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listDatabases(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists Cloud Spanner databases.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
* for (Database element : databaseAdminClient.listDatabases(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* @param parent Required. The instance whose databases should be listed. Values are of the form
* `projects/<project>/instances/<instance>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListDatabasesPagedResponse listDatabases(String parent) {
ListDatabasesRequest request = ListDatabasesRequest.newBuilder().setParent(parent).build();
return listDatabases(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists Cloud Spanner databases.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* ListDatabasesRequest request =
* ListDatabasesRequest.newBuilder()
* .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (Database element : databaseAdminClient.listDatabases(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListDatabasesPagedResponse listDatabases(ListDatabasesRequest request) {
return listDatabasesPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists Cloud Spanner databases.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* ListDatabasesRequest request =
* ListDatabasesRequest.newBuilder()
* .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture<Database> future =
* databaseAdminClient.listDatabasesPagedCallable().futureCall(request);
* // Do something.
* for (Database element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*/
public final UnaryCallable<ListDatabasesRequest, ListDatabasesPagedResponse>
listDatabasesPagedCallable() {
return stub.listDatabasesPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists Cloud Spanner databases.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* while (true) {
* ListDatabasesResponse response = databaseAdminClient.listDatabasesCallable().call(request);
* for (Database element : response.getResponsesList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }</pre>
*/
public final UnaryCallable<ListDatabasesRequest, ListDatabasesResponse> listDatabasesCallable() {
return stub.listDatabasesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new Cloud Spanner database and starts to prepare it for serving. The returned
* [long-running operation][google.longrunning.Operation] will have a name of the format
* `<database_name>/operations/<operation_id>` and can be used to track preparation of
* the database. The [metadata][google.longrunning.Operation.metadata] field type is
* [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The
* [response][google.longrunning.Operation.response] field type is
* [Database][google.spanner.admin.database.v1.Database], if successful.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
* String createStatement = "createStatement744686547";
* Database response = databaseAdminClient.createDatabaseAsync(parent, createStatement).get();
* }
* }</pre>
*
* @param parent Required. The name of the instance that will serve the new database. Values are
* of the form `projects/<project>/instances/<instance>`.
* @param createStatement Required. A `CREATE DATABASE` statement, which specifies the ID of the
* new database. The database ID must conform to the regular expression
* `[a-z][a-z0-9_\\-]*[a-z0-9]` and be between 2 and 30 characters in length. If the
* database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed
* in backticks (`` ` ``).
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Database, CreateDatabaseMetadata> createDatabaseAsync(
InstanceName parent, String createStatement) {
CreateDatabaseRequest request =
CreateDatabaseRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setCreateStatement(createStatement)
.build();
return createDatabaseAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new Cloud Spanner database and starts to prepare it for serving. The returned
* [long-running operation][google.longrunning.Operation] will have a name of the format
* `<database_name>/operations/<operation_id>` and can be used to track preparation of
* the database. The [metadata][google.longrunning.Operation.metadata] field type is
* [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The
* [response][google.longrunning.Operation.response] field type is
* [Database][google.spanner.admin.database.v1.Database], if successful.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
* String createStatement = "createStatement744686547";
* Database response = databaseAdminClient.createDatabaseAsync(parent, createStatement).get();
* }
* }</pre>
*
* @param parent Required. The name of the instance that will serve the new database. Values are
* of the form `projects/<project>/instances/<instance>`.
* @param createStatement Required. A `CREATE DATABASE` statement, which specifies the ID of the
* new database. The database ID must conform to the regular expression
* `[a-z][a-z0-9_\\-]*[a-z0-9]` and be between 2 and 30 characters in length. If the
* database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed
* in backticks (`` ` ``).
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Database, CreateDatabaseMetadata> createDatabaseAsync(
String parent, String createStatement) {
CreateDatabaseRequest request =
CreateDatabaseRequest.newBuilder()
.setParent(parent)
.setCreateStatement(createStatement)
.build();
return createDatabaseAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new Cloud Spanner database and starts to prepare it for serving. The returned
* [long-running operation][google.longrunning.Operation] will have a name of the format
* `<database_name>/operations/<operation_id>` and can be used to track preparation of
* the database. The [metadata][google.longrunning.Operation.metadata] field type is
* [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The
* [response][google.longrunning.Operation.response] field type is
* [Database][google.spanner.admin.database.v1.Database], if successful.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* CreateDatabaseRequest request =
* CreateDatabaseRequest.newBuilder()
* .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .setCreateStatement("createStatement744686547")
* .addAllExtraStatements(new ArrayList<String>())
* .build();
* Database response = databaseAdminClient.createDatabaseAsync(request).get();
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Database, CreateDatabaseMetadata> createDatabaseAsync(
CreateDatabaseRequest request) {
return createDatabaseOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new Cloud Spanner database and starts to prepare it for serving. The returned
* [long-running operation][google.longrunning.Operation] will have a name of the format
* `<database_name>/operations/<operation_id>` and can be used to track preparation of
* the database. The [metadata][google.longrunning.Operation.metadata] field type is
* [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The
* [response][google.longrunning.Operation.response] field type is
* [Database][google.spanner.admin.database.v1.Database], if successful.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* CreateDatabaseRequest request =
* CreateDatabaseRequest.newBuilder()
* .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .setCreateStatement("createStatement744686547")
* .addAllExtraStatements(new ArrayList<String>())
* .build();
* OperationFuture<Database, CreateDatabaseMetadata> future =
* databaseAdminClient.createDatabaseOperationCallable().futureCall(request);
* // Do something.
* Database response = future.get();
* }
* }</pre>
*/
public final OperationCallable<CreateDatabaseRequest, Database, CreateDatabaseMetadata>
createDatabaseOperationCallable() {
return stub.createDatabaseOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new Cloud Spanner database and starts to prepare it for serving. The returned
* [long-running operation][google.longrunning.Operation] will have a name of the format
* `<database_name>/operations/<operation_id>` and can be used to track preparation of
* the database. The [metadata][google.longrunning.Operation.metadata] field type is
* [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The
* [response][google.longrunning.Operation.response] field type is
* [Database][google.spanner.admin.database.v1.Database], if successful.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* CreateDatabaseRequest request =
* CreateDatabaseRequest.newBuilder()
* .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
* .setCreateStatement("createStatement744686547")
* .addAllExtraStatements(new ArrayList<String>())
* .build();
* ApiFuture<Operation> future =
* databaseAdminClient.createDatabaseCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<CreateDatabaseRequest, Operation> createDatabaseCallable() {
return stub.createDatabaseCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the state of a Cloud Spanner database.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* DatabaseName name = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
* Database response = databaseAdminClient.getDatabase(name);
* }
* }</pre>
*
* @param name Required. The name of the requested database. Values are of the form
* `projects/<project>/instances/<instance>/databases/<database>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Database getDatabase(DatabaseName name) {
GetDatabaseRequest request =
GetDatabaseRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getDatabase(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the state of a Cloud Spanner database.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* String name = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
* Database response = databaseAdminClient.getDatabase(name);
* }
* }</pre>
*
* @param name Required. The name of the requested database. Values are of the form
* `projects/<project>/instances/<instance>/databases/<database>`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Database getDatabase(String name) {
GetDatabaseRequest request = GetDatabaseRequest.newBuilder().setName(name).build();
return getDatabase(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the state of a Cloud Spanner database.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* GetDatabaseRequest request =
* GetDatabaseRequest.newBuilder()
* .setName(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
* .build();
* Database response = databaseAdminClient.getDatabase(request);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Database getDatabase(GetDatabaseRequest request) {
return getDatabaseCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the state of a Cloud Spanner database.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* GetDatabaseRequest request =
* GetDatabaseRequest.newBuilder()
* .setName(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
* .build();
* ApiFuture<Database> future = databaseAdminClient.getDatabaseCallable().futureCall(request);
* // Do something.
* Database response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<GetDatabaseRequest, Database> getDatabaseCallable() {
return stub.getDatabaseCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns,
* indexes, etc. The returned [long-running operation][google.longrunning.Operation] will have a
* name of the format `<database_name>/operations/<operation_id>` and can be used to
* track execution of the schema change(s). The [metadata][google.longrunning.Operation.metadata]
* field type is
* [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The
* operation has no response.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
* List<String> statements = new ArrayList<>();
* databaseAdminClient.updateDatabaseDdlAsync(database, statements).get();
* }
* }</pre>
*
* @param database Required. The database to update.
* @param statements Required. DDL statements to be applied to the database.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Empty, UpdateDatabaseDdlMetadata> updateDatabaseDdlAsync(
DatabaseName database, List<String> statements) {
UpdateDatabaseDdlRequest request =
UpdateDatabaseDdlRequest.newBuilder()
.setDatabase(database == null ? null : database.toString())
.addAllStatements(statements)
.build();
return updateDatabaseDdlAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns,
* indexes, etc. The returned [long-running operation][google.longrunning.Operation] will have a
* name of the format `<database_name>/operations/<operation_id>` and can be used to
* track execution of the schema change(s). The [metadata][google.longrunning.Operation.metadata]
* field type is
* [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The
* operation has no response.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
* List<String> statements = new ArrayList<>();
* databaseAdminClient.updateDatabaseDdlAsync(database, statements).get();
* }
* }</pre>
*
* @param database Required. The database to update.
* @param statements Required. DDL statements to be applied to the database.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Empty, UpdateDatabaseDdlMetadata> updateDatabaseDdlAsync(
String database, List<String> statements) {
UpdateDatabaseDdlRequest request =
UpdateDatabaseDdlRequest.newBuilder()
.setDatabase(database)
.addAllStatements(statements)
.build();
return updateDatabaseDdlAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns,
* indexes, etc. The returned [long-running operation][google.longrunning.Operation] will have a
* name of the format `<database_name>/operations/<operation_id>` and can be used to
* track execution of the schema change(s). The [metadata][google.longrunning.Operation.metadata]
* field type is
* [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The
* operation has no response.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* UpdateDatabaseDdlRequest request =
* UpdateDatabaseDdlRequest.newBuilder()
* .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
* .addAllStatements(new ArrayList<String>())
* .setOperationId("operationId129704162")
* .build();
* databaseAdminClient.updateDatabaseDdlAsync(request).get();
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Empty, UpdateDatabaseDdlMetadata> updateDatabaseDdlAsync(
UpdateDatabaseDdlRequest request) {
return updateDatabaseDdlOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns,
* indexes, etc. The returned [long-running operation][google.longrunning.Operation] will have a
* name of the format `<database_name>/operations/<operation_id>` and can be used to
* track execution of the schema change(s). The [metadata][google.longrunning.Operation.metadata]
* field type is
* [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The
* operation has no response.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* UpdateDatabaseDdlRequest request =
* UpdateDatabaseDdlRequest.newBuilder()
* .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
* .addAllStatements(new ArrayList<String>())
* .setOperationId("operationId129704162")
* .build();
* OperationFuture<Empty, UpdateDatabaseDdlMetadata> future =
* databaseAdminClient.updateDatabaseDdlOperationCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }</pre>
*/
public final OperationCallable<UpdateDatabaseDdlRequest, Empty, UpdateDatabaseDdlMetadata>
updateDatabaseDdlOperationCallable() {
return stub.updateDatabaseDdlOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns,
* indexes, etc. The returned [long-running operation][google.longrunning.Operation] will have a
* name of the format `<database_name>/operations/<operation_id>` and can be used to
* track execution of the schema change(s). The [metadata][google.longrunning.Operation.metadata]
* field type is
* [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The
* operation has no response.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* UpdateDatabaseDdlRequest request =
* UpdateDatabaseDdlRequest.newBuilder()
* .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
* .addAllStatements(new ArrayList<String>())
* .setOperationId("operationId129704162")
* .build();
* ApiFuture<Operation> future =
* databaseAdminClient.updateDatabaseDdlCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }</pre>
*/
public final UnaryCallable<UpdateDatabaseDdlRequest, Operation> updateDatabaseDdlCallable() {
return stub.updateDatabaseDdlCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be
* retained according to their `expire_time`.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
* databaseAdminClient.dropDatabase(database);
* }
* }</pre>
*
* @param database Required. The database to be dropped.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void dropDatabase(DatabaseName database) {
DropDatabaseRequest request =
DropDatabaseRequest.newBuilder()
.setDatabase(database == null ? null : database.toString())
.build();
dropDatabase(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be
* retained according to their `expire_time`.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
* databaseAdminClient.dropDatabase(database);
* }
* }</pre>
*
* @param database Required. The database to be dropped.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void dropDatabase(String database) {
DropDatabaseRequest request = DropDatabaseRequest.newBuilder().setDatabase(database).build();
dropDatabase(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be
* retained according to their `expire_time`.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* DropDatabaseRequest request =
* DropDatabaseRequest.newBuilder()
* .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
* .build();
* databaseAdminClient.dropDatabase(request);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void dropDatabase(DropDatabaseRequest request) {
dropDatabaseCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be
* retained according to their `expire_time`.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* DropDatabaseRequest request =
* DropDatabaseRequest.newBuilder()
* .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
* .build();
* ApiFuture<Empty> future = databaseAdminClient.dropDatabaseCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }</pre>
*/
public final UnaryCallable<DropDatabaseRequest, Empty> dropDatabaseCallable() {
return stub.dropDatabaseCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This
* method does not show pending schema updates, those may be queried using the
* [Operations][google.longrunning.Operations] API.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
* GetDatabaseDdlResponse response = databaseAdminClient.getDatabaseDdl(database);
* }
* }</pre>
*
* @param database Required. The database whose schema we wish to get. Values are of the form
* `projects/<project>/instances/<instance>/databases/<database>`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final GetDatabaseDdlResponse getDatabaseDdl(DatabaseName database) {
GetDatabaseDdlRequest request =
GetDatabaseDdlRequest.newBuilder()
.setDatabase(database == null ? null : database.toString())
.build();
return getDatabaseDdl(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This
* method does not show pending schema updates, those may be queried using the
* [Operations][google.longrunning.Operations] API.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
* GetDatabaseDdlResponse response = databaseAdminClient.getDatabaseDdl(database);
* }
* }</pre>
*
* @param database Required. The database whose schema we wish to get. Values are of the form
* `projects/<project>/instances/<instance>/databases/<database>`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final GetDatabaseDdlResponse getDatabaseDdl(String database) {
GetDatabaseDdlRequest request =
GetDatabaseDdlRequest.newBuilder().setDatabase(database).build();
return getDatabaseDdl(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This
* method does not show pending schema updates, those may be queried using the
* [Operations][google.longrunning.Operations] API.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* GetDatabaseDdlRequest request =
* GetDatabaseDdlRequest.newBuilder()
* .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
* .build();
* GetDatabaseDdlResponse response = databaseAdminClient.getDatabaseDdl(request);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final GetDatabaseDdlResponse getDatabaseDdl(GetDatabaseDdlRequest request) {
return getDatabaseDdlCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This
* method does not show pending schema updates, those may be queried using the
* [Operations][google.longrunning.Operations] API.
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* GetDatabaseDdlRequest request =
* GetDatabaseDdlRequest.newBuilder()
* .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
* .build();
* ApiFuture<GetDatabaseDdlResponse> future =
* databaseAdminClient.getDatabaseDdlCallable().futureCall(request);
* // Do something.
* GetDatabaseDdlResponse response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<GetDatabaseDdlRequest, GetDatabaseDdlResponse>
getDatabaseDdlCallable() {
return stub.getDatabaseDdlCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy on a database or backup resource. Replaces any existing policy.
*
* <p>Authorization requires `spanner.databases.setIamPolicy` permission on
* [resource][google.iam.v1.SetIamPolicyRequest.resource]. For backups, authorization requires
* `spanner.backups.setIamPolicy` permission on
* [resource][google.iam.v1.SetIamPolicyRequest.resource].
*
* <p>Sample code:
*
* <pre>{@code
* try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
* ResourceName resource = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
* Policy policy = Policy.newBuilder().build();
* Policy response = databaseAdminClient.setIamPolicy(resource, policy);
* }
* }</pre>
*
* @param resource REQUIRED: The resource for which the policy is being specified. See the
* operation documentation for the appropriate value for this field.
* @param policy REQUIRED: The complete policy to be applied to the `resource`. The size of the
* policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud
* Platform services (such as Projects) might reject them.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy setIamPolicy(ResourceName resource, Policy policy) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(resource == null ? null : resource.toString())
.setPolicy(policy)
.build();
return setIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy on a database or backup resource. Replaces any existing policy.
*
* <p>Authorization requires `spanner.databases.setIamPolicy` permission on