From 7cdfb82b40487600547d0bad92119508161ca689 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Mon, 8 Feb 2021 17:22:10 -0800 Subject: [PATCH] feat: generate sample code in the Java microgenerator (#859) Committer: @miraleung PiperOrigin-RevId: 356341083 Source-Author: Google APIs Source-Date: Mon Feb 8 13:33:28 2021 -0800 Source-Repo: googleapis/googleapis Source-Sha: 8d8c008e56f1af31d57f75561e0f1848ffb29eeb Source-Link: https://github.com/googleapis/googleapis/commit/8d8c008e56f1af31d57f75561e0f1848ffb29eeb --- .../database/v1/DatabaseAdminClient.java | 970 ++++++++++++++++++ .../admin/database/v1/package-info.java | 7 + .../instance/v1/InstanceAdminClient.java | 541 ++++++++++ .../admin/instance/v1/package-info.java | 7 + .../cloud/spanner/v1/SpannerClient.java | 675 ++++++++++++ .../google/cloud/spanner/v1/package-info.java | 7 + synth.metadata | 6 +- 7 files changed, 2210 insertions(+), 3 deletions(-) diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/database/v1/DatabaseAdminClient.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/database/v1/DatabaseAdminClient.java index cab26e0770..9e829e30d4 100644 --- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/database/v1/DatabaseAdminClient.java +++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/database/v1/DatabaseAdminClient.java @@ -85,6 +85,13 @@ *

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: * + * 

{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ *   DatabaseName name = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+ *   Database response = databaseAdminClient.getDatabase(name);
+ * }
+ * }
+ * *

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(). * @@ -199,6 +206,17 @@ public final OperationsClient getOperationsClient() { /** * Lists Cloud Spanner databases. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
+   *   for (Database element : databaseAdminClient.listDatabases(parent).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @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 @@ -215,6 +233,17 @@ public final ListDatabasesPagedResponse listDatabases(InstanceName parent) { /** * Lists Cloud Spanner databases. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
+   *   for (Database element : databaseAdminClient.listDatabases(parent).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @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 @@ -228,6 +257,22 @@ public final ListDatabasesPagedResponse listDatabases(String parent) { /** * Lists Cloud Spanner databases. * + *

Sample code: + * + * 

{@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);
+   *   }
+   * }
+   * }
+ * * @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 */ @@ -240,6 +285,23 @@ public final ListDatabasesPagedResponse listDatabases(ListDatabasesRequest reque * Lists Cloud Spanner databases. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   ListDatabasesRequest request =
+   *       ListDatabasesRequest.newBuilder()
+   *           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+   *           .setPageSize(883849137)
+   *           .setPageToken("pageToken873572522")
+   *           .build();
+   *   ApiFuture future =
+   *       databaseAdminClient.listDatabasesPagedCallable().futureCall(request);
+   *   // Do something.
+   *   for (Database element : future.get().iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
*/ public final UnaryCallable listDatabasesPagedCallable() { @@ -251,6 +313,23 @@ public final ListDatabasesPagedResponse listDatabases(ListDatabasesRequest reque * Lists Cloud Spanner databases. * *

Sample code: + * + * 

{@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;
+   *     }
+   *   }
+   * }
+   * }
*/ public final UnaryCallable listDatabasesCallable() { return stub.listDatabasesCallable(); @@ -266,6 +345,16 @@ public final UnaryCallable listData * [response][google.longrunning.Operation.response] field type is * [Database][google.spanner.admin.database.v1.Database], if successful. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
+   *   String createStatement = "createStatement744686547";
+   *   Database response = databaseAdminClient.createDatabaseAsync(parent, createStatement).get();
+   * }
+   * }
+ * * @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 @@ -295,6 +384,16 @@ public final OperationFuture createDatabaseAsy * [response][google.longrunning.Operation.response] field type is * [Database][google.spanner.admin.database.v1.Database], if successful. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
+   *   String createStatement = "createStatement744686547";
+   *   Database response = databaseAdminClient.createDatabaseAsync(parent, createStatement).get();
+   * }
+   * }
+ * * @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 @@ -324,6 +423,20 @@ public final OperationFuture createDatabaseAsy * [response][google.longrunning.Operation.response] field type is * [Database][google.spanner.admin.database.v1.Database], if successful. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   CreateDatabaseRequest request =
+   *       CreateDatabaseRequest.newBuilder()
+   *           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+   *           .setCreateStatement("createStatement744686547")
+   *           .addAllExtraStatements(new ArrayList())
+   *           .build();
+   *   Database response = databaseAdminClient.createDatabaseAsync(request).get();
+   * }
+   * }
+ * * @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 */ @@ -343,6 +456,21 @@ public final OperationFuture createDatabaseAsy * [Database][google.spanner.admin.database.v1.Database], if successful. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   CreateDatabaseRequest request =
+   *       CreateDatabaseRequest.newBuilder()
+   *           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+   *           .setCreateStatement("createStatement744686547")
+   *           .addAllExtraStatements(new ArrayList())
+   *           .build();
+   *   OperationFuture future =
+   *       databaseAdminClient.createDatabaseOperationCallable().futureCall(request);
+   *   // Do something.
+   *   Database response = future.get();
+   * }
+   * }
*/ public final OperationCallable createDatabaseOperationCallable() { @@ -360,6 +488,21 @@ public final OperationFuture createDatabaseAsy * [Database][google.spanner.admin.database.v1.Database], if successful. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   CreateDatabaseRequest request =
+   *       CreateDatabaseRequest.newBuilder()
+   *           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+   *           .setCreateStatement("createStatement744686547")
+   *           .addAllExtraStatements(new ArrayList())
+   *           .build();
+   *   ApiFuture future =
+   *       databaseAdminClient.createDatabaseCallable().futureCall(request);
+   *   // Do something.
+   *   Operation response = future.get();
+   * }
+   * }
*/ public final UnaryCallable createDatabaseCallable() { return stub.createDatabaseCallable(); @@ -369,6 +512,15 @@ public final UnaryCallable createDatabaseCalla /** * Gets the state of a Cloud Spanner database. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   DatabaseName name = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+   *   Database response = databaseAdminClient.getDatabase(name);
+   * }
+   * }
+ * * @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 @@ -383,6 +535,15 @@ public final Database getDatabase(DatabaseName name) { /** * Gets the state of a Cloud Spanner database. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   String name = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
+   *   Database response = databaseAdminClient.getDatabase(name);
+   * }
+   * }
+ * * @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 @@ -396,6 +557,18 @@ public final Database getDatabase(String name) { /** * Gets the state of a Cloud Spanner database. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   GetDatabaseRequest request =
+   *       GetDatabaseRequest.newBuilder()
+   *           .setName(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+   *           .build();
+   *   Database response = databaseAdminClient.getDatabase(request);
+   * }
+   * }
+ * * @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 */ @@ -408,6 +581,18 @@ public final Database getDatabase(GetDatabaseRequest request) { * Gets the state of a Cloud Spanner database. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   GetDatabaseRequest request =
+   *       GetDatabaseRequest.newBuilder()
+   *           .setName(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+   *           .build();
+   *   ApiFuture future = databaseAdminClient.getDatabaseCallable().futureCall(request);
+   *   // Do something.
+   *   Database response = future.get();
+   * }
+   * }
*/ public final UnaryCallable getDatabaseCallable() { return stub.getDatabaseCallable(); @@ -423,6 +608,16 @@ public final UnaryCallable getDatabaseCallable() { * [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The * operation has no response. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+   *   List statements = new ArrayList<>();
+   *   databaseAdminClient.updateDatabaseDdlAsync(database, statements).get();
+   * }
+   * }
+ * * @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 @@ -447,6 +642,16 @@ public final OperationFuture updateDatabaseDdl * [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The * operation has no response. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
+   *   List statements = new ArrayList<>();
+   *   databaseAdminClient.updateDatabaseDdlAsync(database, statements).get();
+   * }
+   * }
+ * * @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 @@ -471,6 +676,20 @@ public final OperationFuture updateDatabaseDdl * [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The * operation has no response. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   UpdateDatabaseDdlRequest request =
+   *       UpdateDatabaseDdlRequest.newBuilder()
+   *           .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+   *           .addAllStatements(new ArrayList())
+   *           .setOperationId("operationId129704162")
+   *           .build();
+   *   databaseAdminClient.updateDatabaseDdlAsync(request).get();
+   * }
+   * }
+ * * @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 */ @@ -490,6 +709,21 @@ public final OperationFuture updateDatabaseDdl * operation has no response. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   UpdateDatabaseDdlRequest request =
+   *       UpdateDatabaseDdlRequest.newBuilder()
+   *           .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+   *           .addAllStatements(new ArrayList())
+   *           .setOperationId("operationId129704162")
+   *           .build();
+   *   OperationFuture future =
+   *       databaseAdminClient.updateDatabaseDdlOperationCallable().futureCall(request);
+   *   // Do something.
+   *   future.get();
+   * }
+   * }
*/ public final OperationCallable updateDatabaseDdlOperationCallable() { @@ -507,6 +741,21 @@ public final OperationFuture updateDatabaseDdl * operation has no response. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   UpdateDatabaseDdlRequest request =
+   *       UpdateDatabaseDdlRequest.newBuilder()
+   *           .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+   *           .addAllStatements(new ArrayList())
+   *           .setOperationId("operationId129704162")
+   *           .build();
+   *   ApiFuture future =
+   *       databaseAdminClient.updateDatabaseDdlCallable().futureCall(request);
+   *   // Do something.
+   *   future.get();
+   * }
+   * }
*/ public final UnaryCallable updateDatabaseDdlCallable() { return stub.updateDatabaseDdlCallable(); @@ -517,6 +766,15 @@ public final UnaryCallable updateDatabaseDd * Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be * retained according to their `expire_time`. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+   *   databaseAdminClient.dropDatabase(database);
+   * }
+   * }
+ * * @param database Required. The database to be dropped. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -533,6 +791,15 @@ public final void dropDatabase(DatabaseName database) { * Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be * retained according to their `expire_time`. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
+   *   databaseAdminClient.dropDatabase(database);
+   * }
+   * }
+ * * @param database Required. The database to be dropped. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -546,6 +813,18 @@ public final void dropDatabase(String database) { * Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be * retained according to their `expire_time`. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   DropDatabaseRequest request =
+   *       DropDatabaseRequest.newBuilder()
+   *           .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+   *           .build();
+   *   databaseAdminClient.dropDatabase(request);
+   * }
+   * }
+ * * @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 */ @@ -559,6 +838,18 @@ public final void dropDatabase(DropDatabaseRequest request) { * retained according to their `expire_time`. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   DropDatabaseRequest request =
+   *       DropDatabaseRequest.newBuilder()
+   *           .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+   *           .build();
+   *   ApiFuture future = databaseAdminClient.dropDatabaseCallable().futureCall(request);
+   *   // Do something.
+   *   future.get();
+   * }
+   * }
*/ public final UnaryCallable dropDatabaseCallable() { return stub.dropDatabaseCallable(); @@ -570,6 +861,15 @@ public final UnaryCallable dropDatabaseCallable() { * method does not show pending schema updates, those may be queried using the * [Operations][google.longrunning.Operations] API. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+   *   GetDatabaseDdlResponse response = databaseAdminClient.getDatabaseDdl(database);
+   * }
+   * }
+ * * @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 @@ -588,6 +888,15 @@ public final GetDatabaseDdlResponse getDatabaseDdl(DatabaseName database) { * method does not show pending schema updates, those may be queried using the * [Operations][google.longrunning.Operations] API. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
+   *   GetDatabaseDdlResponse response = databaseAdminClient.getDatabaseDdl(database);
+   * }
+   * }
+ * * @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 @@ -604,6 +913,18 @@ public final GetDatabaseDdlResponse getDatabaseDdl(String database) { * method does not show pending schema updates, those may be queried using the * [Operations][google.longrunning.Operations] API. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   GetDatabaseDdlRequest request =
+   *       GetDatabaseDdlRequest.newBuilder()
+   *           .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+   *           .build();
+   *   GetDatabaseDdlResponse response = databaseAdminClient.getDatabaseDdl(request);
+   * }
+   * }
+ * * @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 */ @@ -618,6 +939,19 @@ public final GetDatabaseDdlResponse getDatabaseDdl(GetDatabaseDdlRequest request * [Operations][google.longrunning.Operations] API. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   GetDatabaseDdlRequest request =
+   *       GetDatabaseDdlRequest.newBuilder()
+   *           .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+   *           .build();
+   *   ApiFuture future =
+   *       databaseAdminClient.getDatabaseDdlCallable().futureCall(request);
+   *   // Do something.
+   *   GetDatabaseDdlResponse response = future.get();
+   * }
+   * }
*/ public final UnaryCallable getDatabaseDdlCallable() { @@ -633,6 +967,16 @@ public final GetDatabaseDdlResponse getDatabaseDdl(GetDatabaseDdlRequest request * `spanner.backups.setIamPolicy` permission on * [resource][google.iam.v1.SetIamPolicyRequest.resource]. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   ResourceName resource = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+   *   Policy policy = Policy.newBuilder().build();
+   *   Policy response = databaseAdminClient.setIamPolicy(resource, policy);
+   * }
+   * }
+ * * @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 @@ -658,6 +1002,16 @@ public final Policy setIamPolicy(ResourceName resource, Policy policy) { * `spanner.backups.setIamPolicy` permission on * [resource][google.iam.v1.SetIamPolicyRequest.resource]. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   String resource = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
+   *   Policy policy = Policy.newBuilder().build();
+   *   Policy response = databaseAdminClient.setIamPolicy(resource, policy);
+   * }
+   * }
+ * * @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 @@ -680,6 +1034,19 @@ public final Policy setIamPolicy(String resource, Policy policy) { * `spanner.backups.setIamPolicy` permission on * [resource][google.iam.v1.SetIamPolicyRequest.resource]. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   SetIamPolicyRequest request =
+   *       SetIamPolicyRequest.newBuilder()
+   *           .setResource(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+   *           .setPolicy(Policy.newBuilder().build())
+   *           .build();
+   *   Policy response = databaseAdminClient.setIamPolicy(request);
+   * }
+   * }
+ * * @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 */ @@ -697,6 +1064,19 @@ public final Policy setIamPolicy(SetIamPolicyRequest request) { * [resource][google.iam.v1.SetIamPolicyRequest.resource]. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   SetIamPolicyRequest request =
+   *       SetIamPolicyRequest.newBuilder()
+   *           .setResource(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+   *           .setPolicy(Policy.newBuilder().build())
+   *           .build();
+   *   ApiFuture future = databaseAdminClient.setIamPolicyCallable().futureCall(request);
+   *   // Do something.
+   *   Policy response = future.get();
+   * }
+   * }
*/ public final UnaryCallable setIamPolicyCallable() { return stub.setIamPolicyCallable(); @@ -712,6 +1092,15 @@ public final UnaryCallable setIamPolicyCallable() { * `spanner.backups.getIamPolicy` permission on * [resource][google.iam.v1.GetIamPolicyRequest.resource]. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   ResourceName resource = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+   *   Policy response = databaseAdminClient.getIamPolicy(resource);
+   * }
+   * }
+ * * @param resource REQUIRED: The resource for which the policy is being requested. See the * operation documentation for the appropriate value for this field. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -734,6 +1123,15 @@ public final Policy getIamPolicy(ResourceName resource) { * `spanner.backups.getIamPolicy` permission on * [resource][google.iam.v1.GetIamPolicyRequest.resource]. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   String resource = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
+   *   Policy response = databaseAdminClient.getIamPolicy(resource);
+   * }
+   * }
+ * * @param resource REQUIRED: The resource for which the policy is being requested. See the * operation documentation for the appropriate value for this field. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -753,6 +1151,19 @@ public final Policy getIamPolicy(String resource) { * `spanner.backups.getIamPolicy` permission on * [resource][google.iam.v1.GetIamPolicyRequest.resource]. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   GetIamPolicyRequest request =
+   *       GetIamPolicyRequest.newBuilder()
+   *           .setResource(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+   *           .setOptions(GetPolicyOptions.newBuilder().build())
+   *           .build();
+   *   Policy response = databaseAdminClient.getIamPolicy(request);
+   * }
+   * }
+ * * @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 */ @@ -771,6 +1182,19 @@ public final Policy getIamPolicy(GetIamPolicyRequest request) { * [resource][google.iam.v1.GetIamPolicyRequest.resource]. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   GetIamPolicyRequest request =
+   *       GetIamPolicyRequest.newBuilder()
+   *           .setResource(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+   *           .setOptions(GetPolicyOptions.newBuilder().build())
+   *           .build();
+   *   ApiFuture future = databaseAdminClient.getIamPolicyCallable().futureCall(request);
+   *   // Do something.
+   *   Policy response = future.get();
+   * }
+   * }
*/ public final UnaryCallable getIamPolicyCallable() { return stub.getIamPolicyCallable(); @@ -786,6 +1210,17 @@ public final UnaryCallable getIamPolicyCallable() { * does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` * permission on the containing instance. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   ResourceName resource = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+   *   List permissions = new ArrayList<>();
+   *   TestIamPermissionsResponse response =
+   *       databaseAdminClient.testIamPermissions(resource, permissions);
+   * }
+   * }
+ * * @param resource REQUIRED: The resource for which the policy detail is being requested. See the * operation documentation for the appropriate value for this field. * @param permissions The set of permissions to check for the `resource`. Permissions with @@ -813,6 +1248,17 @@ public final TestIamPermissionsResponse testIamPermissions( * does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` * permission on the containing instance. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   String resource = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
+   *   List permissions = new ArrayList<>();
+   *   TestIamPermissionsResponse response =
+   *       databaseAdminClient.testIamPermissions(resource, permissions);
+   * }
+   * }
+ * * @param resource REQUIRED: The resource for which the policy detail is being requested. See the * operation documentation for the appropriate value for this field. * @param permissions The set of permissions to check for the `resource`. Permissions with @@ -840,6 +1286,19 @@ public final TestIamPermissionsResponse testIamPermissions( * does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` * permission on the containing instance. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   TestIamPermissionsRequest request =
+   *       TestIamPermissionsRequest.newBuilder()
+   *           .setResource(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+   *           .addAllPermissions(new ArrayList())
+   *           .build();
+   *   TestIamPermissionsResponse response = databaseAdminClient.testIamPermissions(request);
+   * }
+   * }
+ * * @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 */ @@ -858,6 +1317,20 @@ public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsReq * permission on the containing instance. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   TestIamPermissionsRequest request =
+   *       TestIamPermissionsRequest.newBuilder()
+   *           .setResource(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+   *           .addAllPermissions(new ArrayList())
+   *           .build();
+   *   ApiFuture future =
+   *       databaseAdminClient.testIamPermissionsCallable().futureCall(request);
+   *   // Do something.
+   *   TestIamPermissionsResponse response = future.get();
+   * }
+   * }
*/ public final UnaryCallable testIamPermissionsCallable() { @@ -877,6 +1350,17 @@ public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsReq * operation will stop the creation and delete the backup. There can be only one pending backup * creation per database. Backup creation of different databases can run concurrently. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
+   *   Backup backup = Backup.newBuilder().build();
+   *   String backupId = "backupId2121930365";
+   *   Backup response = databaseAdminClient.createBackupAsync(parent, backup, backupId).get();
+   * }
+   * }
+ * * @param parent Required. The name of the instance in which the backup will be created. This must * be the same instance that contains the database the backup will be created from. The backup * will be stored in the location(s) specified in the instance configuration of this instance. @@ -911,6 +1395,17 @@ public final OperationFuture createBackupAsync( * operation will stop the creation and delete the backup. There can be only one pending backup * creation per database. Backup creation of different databases can run concurrently. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
+   *   Backup backup = Backup.newBuilder().build();
+   *   String backupId = "backupId2121930365";
+   *   Backup response = databaseAdminClient.createBackupAsync(parent, backup, backupId).get();
+   * }
+   * }
+ * * @param parent Required. The name of the instance in which the backup will be created. This must * be the same instance that contains the database the backup will be created from. The backup * will be stored in the location(s) specified in the instance configuration of this instance. @@ -945,6 +1440,20 @@ public final OperationFuture createBackupAsync( * operation will stop the creation and delete the backup. There can be only one pending backup * creation per database. Backup creation of different databases can run concurrently. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   CreateBackupRequest request =
+   *       CreateBackupRequest.newBuilder()
+   *           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+   *           .setBackupId("backupId2121930365")
+   *           .setBackup(Backup.newBuilder().build())
+   *           .build();
+   *   Backup response = databaseAdminClient.createBackupAsync(request).get();
+   * }
+   * }
+ * * @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 */ @@ -967,6 +1476,21 @@ public final OperationFuture createBackupAsync( * creation per database. Backup creation of different databases can run concurrently. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   CreateBackupRequest request =
+   *       CreateBackupRequest.newBuilder()
+   *           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+   *           .setBackupId("backupId2121930365")
+   *           .setBackup(Backup.newBuilder().build())
+   *           .build();
+   *   OperationFuture future =
+   *       databaseAdminClient.createBackupOperationCallable().futureCall(request);
+   *   // Do something.
+   *   Backup response = future.get();
+   * }
+   * }
*/ public final OperationCallable createBackupOperationCallable() { @@ -987,6 +1511,20 @@ public final OperationFuture createBackupAsync( * creation per database. Backup creation of different databases can run concurrently. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   CreateBackupRequest request =
+   *       CreateBackupRequest.newBuilder()
+   *           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+   *           .setBackupId("backupId2121930365")
+   *           .setBackup(Backup.newBuilder().build())
+   *           .build();
+   *   ApiFuture future = databaseAdminClient.createBackupCallable().futureCall(request);
+   *   // Do something.
+   *   Operation response = future.get();
+   * }
+   * }
*/ public final UnaryCallable createBackupCallable() { return stub.createBackupCallable(); @@ -996,6 +1534,15 @@ public final UnaryCallable createBackupCallable( /** * Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup]. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   BackupName name = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]");
+   *   Backup response = databaseAdminClient.getBackup(name);
+   * }
+   * }
+ * * @param name Required. Name of the backup. Values are of the form * `projects/<project>/instances/<instance>/backups/<backup>`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -1010,6 +1557,15 @@ public final Backup getBackup(BackupName name) { /** * Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup]. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   String name = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString();
+   *   Backup response = databaseAdminClient.getBackup(name);
+   * }
+   * }
+ * * @param name Required. Name of the backup. Values are of the form * `projects/<project>/instances/<instance>/backups/<backup>`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -1023,6 +1579,18 @@ public final Backup getBackup(String name) { /** * Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup]. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   GetBackupRequest request =
+   *       GetBackupRequest.newBuilder()
+   *           .setName(BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString())
+   *           .build();
+   *   Backup response = databaseAdminClient.getBackup(request);
+   * }
+   * }
+ * * @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 */ @@ -1035,6 +1603,18 @@ public final Backup getBackup(GetBackupRequest request) { * Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup]. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   GetBackupRequest request =
+   *       GetBackupRequest.newBuilder()
+   *           .setName(BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString())
+   *           .build();
+   *   ApiFuture future = databaseAdminClient.getBackupCallable().futureCall(request);
+   *   // Do something.
+   *   Backup response = future.get();
+   * }
+   * }
*/ public final UnaryCallable getBackupCallable() { return stub.getBackupCallable(); @@ -1044,6 +1624,16 @@ public final UnaryCallable getBackupCallable() { /** * Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup]. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   Backup backup = Backup.newBuilder().build();
+   *   FieldMask updateMask = FieldMask.newBuilder().build();
+   *   Backup response = databaseAdminClient.updateBackup(backup, updateMask);
+   * }
+   * }
+ * * @param backup Required. The backup to update. `backup.name`, and the fields to be updated as * specified by `update_mask` are required. Other fields are ignored. Update is only supported * for the following fields: * `backup.expire_time`. @@ -1063,6 +1653,19 @@ public final Backup updateBackup(Backup backup, FieldMask updateMask) { /** * Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup]. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   UpdateBackupRequest request =
+   *       UpdateBackupRequest.newBuilder()
+   *           .setBackup(Backup.newBuilder().build())
+   *           .setUpdateMask(FieldMask.newBuilder().build())
+   *           .build();
+   *   Backup response = databaseAdminClient.updateBackup(request);
+   * }
+   * }
+ * * @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 */ @@ -1075,6 +1678,19 @@ public final Backup updateBackup(UpdateBackupRequest request) { * Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup]. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   UpdateBackupRequest request =
+   *       UpdateBackupRequest.newBuilder()
+   *           .setBackup(Backup.newBuilder().build())
+   *           .setUpdateMask(FieldMask.newBuilder().build())
+   *           .build();
+   *   ApiFuture future = databaseAdminClient.updateBackupCallable().futureCall(request);
+   *   // Do something.
+   *   Backup response = future.get();
+   * }
+   * }
*/ public final UnaryCallable updateBackupCallable() { return stub.updateBackupCallable(); @@ -1084,6 +1700,15 @@ public final UnaryCallable updateBackupCallable() { /** * Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup]. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   BackupName name = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]");
+   *   databaseAdminClient.deleteBackup(name);
+   * }
+   * }
+ * * @param name Required. Name of the backup to delete. Values are of the form * `projects/<project>/instances/<instance>/backups/<backup>`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -1098,6 +1723,15 @@ public final void deleteBackup(BackupName name) { /** * Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup]. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   String name = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString();
+   *   databaseAdminClient.deleteBackup(name);
+   * }
+   * }
+ * * @param name Required. Name of the backup to delete. Values are of the form * `projects/<project>/instances/<instance>/backups/<backup>`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -1111,6 +1745,18 @@ public final void deleteBackup(String name) { /** * Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup]. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   DeleteBackupRequest request =
+   *       DeleteBackupRequest.newBuilder()
+   *           .setName(BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString())
+   *           .build();
+   *   databaseAdminClient.deleteBackup(request);
+   * }
+   * }
+ * * @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 */ @@ -1123,6 +1769,18 @@ public final void deleteBackup(DeleteBackupRequest request) { * Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup]. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   DeleteBackupRequest request =
+   *       DeleteBackupRequest.newBuilder()
+   *           .setName(BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString())
+   *           .build();
+   *   ApiFuture future = databaseAdminClient.deleteBackupCallable().futureCall(request);
+   *   // Do something.
+   *   future.get();
+   * }
+   * }
*/ public final UnaryCallable deleteBackupCallable() { return stub.deleteBackupCallable(); @@ -1133,6 +1791,17 @@ public final UnaryCallable deleteBackupCallable() { * Lists completed and pending backups. Backups returned are ordered by `create_time` in * descending order, starting from the most recent `create_time`. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
+   *   for (Backup element : databaseAdminClient.listBackups(parent).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @param parent Required. The instance to list backups from. Values are of the form * `projects/<project>/instances/<instance>`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -1150,6 +1819,17 @@ public final ListBackupsPagedResponse listBackups(InstanceName parent) { * Lists completed and pending backups. Backups returned are ordered by `create_time` in * descending order, starting from the most recent `create_time`. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
+   *   for (Backup element : databaseAdminClient.listBackups(parent).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @param parent Required. The instance to list backups from. Values are of the form * `projects/<project>/instances/<instance>`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -1164,6 +1844,23 @@ public final ListBackupsPagedResponse listBackups(String parent) { * Lists completed and pending backups. Backups returned are ordered by `create_time` in * descending order, starting from the most recent `create_time`. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   ListBackupsRequest request =
+   *       ListBackupsRequest.newBuilder()
+   *           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+   *           .setFilter("filter-1274492040")
+   *           .setPageSize(883849137)
+   *           .setPageToken("pageToken873572522")
+   *           .build();
+   *   for (Backup element : databaseAdminClient.listBackups(request).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @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 */ @@ -1177,6 +1874,23 @@ public final ListBackupsPagedResponse listBackups(ListBackupsRequest request) { * descending order, starting from the most recent `create_time`. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   ListBackupsRequest request =
+   *       ListBackupsRequest.newBuilder()
+   *           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+   *           .setFilter("filter-1274492040")
+   *           .setPageSize(883849137)
+   *           .setPageToken("pageToken873572522")
+   *           .build();
+   *   ApiFuture future = databaseAdminClient.listBackupsPagedCallable().futureCall(request);
+   *   // Do something.
+   *   for (Backup element : future.get().iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
*/ public final UnaryCallable listBackupsPagedCallable() { @@ -1189,6 +1903,23 @@ public final ListBackupsPagedResponse listBackups(ListBackupsRequest request) { * descending order, starting from the most recent `create_time`. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   while (true) {
+   *     ListBackupsResponse response = databaseAdminClient.listBackupsCallable().call(request);
+   *     for (Backup element : response.getResponsesList()) {
+   *       // doThingsWith(element);
+   *     }
+   *     String nextPageToken = response.getNextPageToken();
+   *     if (!Strings.isNullOrEmpty(nextPageToken)) {
+   *       request = request.toBuilder().setPageToken(nextPageToken).build();
+   *     } else {
+   *       break;
+   *     }
+   *   }
+   * }
+   * }
*/ public final UnaryCallable listBackupsCallable() { return stub.listBackupsCallable(); @@ -1211,6 +1942,18 @@ public final UnaryCallable listBackupsC * operation can be initiated, without waiting for the optimize operation associated with the * first restore to complete. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
+   *   String databaseId = "databaseId1688905718";
+   *   BackupName backup = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]");
+   *   Database response =
+   *       databaseAdminClient.restoreDatabaseAsync(parent, databaseId, backup).get();
+   * }
+   * }
+ * * @param parent Required. The name of the instance in which to create the restored database. This * instance must be in the same project and have the same instance configuration as the * instance containing the source backup. Values are of the form @@ -1251,6 +1994,18 @@ public final OperationFuture restoreDatabaseA * operation can be initiated, without waiting for the optimize operation associated with the * first restore to complete. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
+   *   String databaseId = "databaseId1688905718";
+   *   String backup = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString();
+   *   Database response =
+   *       databaseAdminClient.restoreDatabaseAsync(parent, databaseId, backup).get();
+   * }
+   * }
+ * * @param parent Required. The name of the instance in which to create the restored database. This * instance must be in the same project and have the same instance configuration as the * instance containing the source backup. Values are of the form @@ -1291,6 +2046,18 @@ public final OperationFuture restoreDatabaseA * operation can be initiated, without waiting for the optimize operation associated with the * first restore to complete. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
+   *   String databaseId = "databaseId1688905718";
+   *   BackupName backup = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]");
+   *   Database response =
+   *       databaseAdminClient.restoreDatabaseAsync(parent, databaseId, backup).get();
+   * }
+   * }
+ * * @param parent Required. The name of the instance in which to create the restored database. This * instance must be in the same project and have the same instance configuration as the * instance containing the source backup. Values are of the form @@ -1331,6 +2098,18 @@ public final OperationFuture restoreDatabaseA * operation can be initiated, without waiting for the optimize operation associated with the * first restore to complete. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
+   *   String databaseId = "databaseId1688905718";
+   *   String backup = BackupName.of("[PROJECT]", "[INSTANCE]", "[BACKUP]").toString();
+   *   Database response =
+   *       databaseAdminClient.restoreDatabaseAsync(parent, databaseId, backup).get();
+   * }
+   * }
+ * * @param parent Required. The name of the instance in which to create the restored database. This * instance must be in the same project and have the same instance configuration as the * instance containing the source backup. Values are of the form @@ -1371,6 +2150,19 @@ public final OperationFuture restoreDatabaseA * operation can be initiated, without waiting for the optimize operation associated with the * first restore to complete. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   RestoreDatabaseRequest request =
+   *       RestoreDatabaseRequest.newBuilder()
+   *           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+   *           .setDatabaseId("databaseId1688905718")
+   *           .build();
+   *   Database response = databaseAdminClient.restoreDatabaseAsync(request).get();
+   * }
+   * }
+ * * @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 */ @@ -1397,6 +2189,20 @@ public final OperationFuture restoreDatabaseA * first restore to complete. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   RestoreDatabaseRequest request =
+   *       RestoreDatabaseRequest.newBuilder()
+   *           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+   *           .setDatabaseId("databaseId1688905718")
+   *           .build();
+   *   OperationFuture future =
+   *       databaseAdminClient.restoreDatabaseOperationCallable().futureCall(request);
+   *   // Do something.
+   *   Database response = future.get();
+   * }
+   * }
*/ public final OperationCallable restoreDatabaseOperationCallable() { @@ -1421,6 +2227,20 @@ public final OperationFuture restoreDatabaseA * first restore to complete. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   RestoreDatabaseRequest request =
+   *       RestoreDatabaseRequest.newBuilder()
+   *           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+   *           .setDatabaseId("databaseId1688905718")
+   *           .build();
+   *   ApiFuture future =
+   *       databaseAdminClient.restoreDatabaseCallable().futureCall(request);
+   *   // Do something.
+   *   Operation response = future.get();
+   * }
+   * }
*/ public final UnaryCallable restoreDatabaseCallable() { return stub.restoreDatabaseCallable(); @@ -1435,6 +2255,17 @@ public final UnaryCallable restoreDatabaseCal * `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. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
+   *   for (Operation element : databaseAdminClient.listDatabaseOperations(parent).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @param parent Required. The instance of the database operations. Values are of the form * `projects/<project>/instances/<instance>`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -1456,6 +2287,17 @@ public final ListDatabaseOperationsPagedResponse listDatabaseOperations(Instance * `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. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
+   *   for (Operation element : databaseAdminClient.listDatabaseOperations(parent).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @param parent Required. The instance of the database operations. Values are of the form * `projects/<project>/instances/<instance>`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -1475,6 +2317,23 @@ public final ListDatabaseOperationsPagedResponse listDatabaseOperations(String p * `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. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   ListDatabaseOperationsRequest request =
+   *       ListDatabaseOperationsRequest.newBuilder()
+   *           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+   *           .setFilter("filter-1274492040")
+   *           .setPageSize(883849137)
+   *           .setPageToken("pageToken873572522")
+   *           .build();
+   *   for (Operation element : databaseAdminClient.listDatabaseOperations(request).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @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 */ @@ -1493,6 +2352,24 @@ public final ListDatabaseOperationsPagedResponse listDatabaseOperations( * have completed/failed/canceled within the last 7 days, and pending operations. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   ListDatabaseOperationsRequest request =
+   *       ListDatabaseOperationsRequest.newBuilder()
+   *           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+   *           .setFilter("filter-1274492040")
+   *           .setPageSize(883849137)
+   *           .setPageToken("pageToken873572522")
+   *           .build();
+   *   ApiFuture future =
+   *       databaseAdminClient.listDatabaseOperationsPagedCallable().futureCall(request);
+   *   // Do something.
+   *   for (Operation element : future.get().iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
*/ public final UnaryCallable listDatabaseOperationsPagedCallable() { @@ -1509,6 +2386,24 @@ public final ListDatabaseOperationsPagedResponse listDatabaseOperations( * have completed/failed/canceled within the last 7 days, and pending operations. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   while (true) {
+   *     ListDatabaseOperationsResponse response =
+   *         databaseAdminClient.listDatabaseOperationsCallable().call(request);
+   *     for (Operation element : response.getResponsesList()) {
+   *       // doThingsWith(element);
+   *     }
+   *     String nextPageToken = response.getNextPageToken();
+   *     if (!Strings.isNullOrEmpty(nextPageToken)) {
+   *       request = request.toBuilder().setPageToken(nextPageToken).build();
+   *     } else {
+   *       break;
+   *     }
+   *   }
+   * }
+   * }
*/ public final UnaryCallable listDatabaseOperationsCallable() { @@ -1526,6 +2421,17 @@ public final ListDatabaseOperationsPagedResponse listDatabaseOperations( * returned are ordered by `operation.metadata.value.progress.start_time` in descending order * starting from the most recently started operation. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   InstanceName parent = InstanceName.of("[PROJECT]", "[INSTANCE]");
+   *   for (Operation element : databaseAdminClient.listBackupOperations(parent).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @param parent Required. The instance of the backup operations. Values are of the form * `projects/<project>/instances/<instance>`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -1549,6 +2455,17 @@ public final ListBackupOperationsPagedResponse listBackupOperations(InstanceName * returned are ordered by `operation.metadata.value.progress.start_time` in descending order * starting from the most recently started operation. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   String parent = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
+   *   for (Operation element : databaseAdminClient.listBackupOperations(parent).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @param parent Required. The instance of the backup operations. Values are of the form * `projects/<project>/instances/<instance>`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -1570,6 +2487,23 @@ public final ListBackupOperationsPagedResponse listBackupOperations(String paren * returned are ordered by `operation.metadata.value.progress.start_time` in descending order * starting from the most recently started operation. * + *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   ListBackupOperationsRequest request =
+   *       ListBackupOperationsRequest.newBuilder()
+   *           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+   *           .setFilter("filter-1274492040")
+   *           .setPageSize(883849137)
+   *           .setPageToken("pageToken873572522")
+   *           .build();
+   *   for (Operation element : databaseAdminClient.listBackupOperations(request).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @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 */ @@ -1590,6 +2524,24 @@ public final ListBackupOperationsPagedResponse listBackupOperations( * starting from the most recently started operation. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   ListBackupOperationsRequest request =
+   *       ListBackupOperationsRequest.newBuilder()
+   *           .setParent(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+   *           .setFilter("filter-1274492040")
+   *           .setPageSize(883849137)
+   *           .setPageToken("pageToken873572522")
+   *           .build();
+   *   ApiFuture future =
+   *       databaseAdminClient.listBackupOperationsPagedCallable().futureCall(request);
+   *   // Do something.
+   *   for (Operation element : future.get().iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
*/ public final UnaryCallable listBackupOperationsPagedCallable() { @@ -1608,6 +2560,24 @@ public final ListBackupOperationsPagedResponse listBackupOperations( * starting from the most recently started operation. * *

Sample code: + * + * 

{@code
+   * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+   *   while (true) {
+   *     ListBackupOperationsResponse response =
+   *         databaseAdminClient.listBackupOperationsCallable().call(request);
+   *     for (Operation element : response.getResponsesList()) {
+   *       // doThingsWith(element);
+   *     }
+   *     String nextPageToken = response.getNextPageToken();
+   *     if (!Strings.isNullOrEmpty(nextPageToken)) {
+   *       request = request.toBuilder().setPageToken(nextPageToken).build();
+   *     } else {
+   *       break;
+   *     }
+   *   }
+   * }
+   * }
*/ public final UnaryCallable listBackupOperationsCallable() { diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/database/v1/package-info.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/database/v1/package-info.java index a7a4a8722e..6723f47e82 100644 --- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/database/v1/package-info.java +++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/database/v1/package-info.java @@ -26,6 +26,13 @@ * list backups for a database and to restore from an existing backup. * *

Sample for DatabaseAdminClient: + * + * 

{@code
+ * try (DatabaseAdminClient databaseAdminClient = DatabaseAdminClient.create()) {
+ *   DatabaseName name = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+ *   Database response = databaseAdminClient.getDatabase(name);
+ * }
+ * }
*/ @Generated("by gapic-generator-java") package com.google.cloud.spanner.admin.database.v1; diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/instance/v1/InstanceAdminClient.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/instance/v1/InstanceAdminClient.java index 6494e0eac9..68c0be81db 100644 --- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/instance/v1/InstanceAdminClient.java +++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/instance/v1/InstanceAdminClient.java @@ -85,6 +85,13 @@ *

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: * + * 

{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ *   InstanceConfigName name = InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]");
+ *   InstanceConfig response = instanceAdminClient.getInstanceConfig(name);
+ * }
+ * }
+ * *

Note: close() needs to be called on the InstanceAdminClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * @@ -199,6 +206,17 @@ public final OperationsClient getOperationsClient() { /** * Lists the supported instance configurations for a given project. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   ProjectName parent = ProjectName.of("[PROJECT]");
+   *   for (InstanceConfig element : instanceAdminClient.listInstanceConfigs(parent).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @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>`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -215,6 +233,17 @@ public final ListInstanceConfigsPagedResponse listInstanceConfigs(ProjectName pa /** * Lists the supported instance configurations for a given project. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   String parent = ProjectName.of("[PROJECT]").toString();
+   *   for (InstanceConfig element : instanceAdminClient.listInstanceConfigs(parent).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @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>`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -229,6 +258,22 @@ public final ListInstanceConfigsPagedResponse listInstanceConfigs(String parent) /** * Lists the supported instance configurations for a given project. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   ListInstanceConfigsRequest request =
+   *       ListInstanceConfigsRequest.newBuilder()
+   *           .setParent(ProjectName.of("[PROJECT]").toString())
+   *           .setPageSize(883849137)
+   *           .setPageToken("pageToken873572522")
+   *           .build();
+   *   for (InstanceConfig element : instanceAdminClient.listInstanceConfigs(request).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @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 */ @@ -242,6 +287,23 @@ public final ListInstanceConfigsPagedResponse listInstanceConfigs( * Lists the supported instance configurations for a given project. * *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   ListInstanceConfigsRequest request =
+   *       ListInstanceConfigsRequest.newBuilder()
+   *           .setParent(ProjectName.of("[PROJECT]").toString())
+   *           .setPageSize(883849137)
+   *           .setPageToken("pageToken873572522")
+   *           .build();
+   *   ApiFuture future =
+   *       instanceAdminClient.listInstanceConfigsPagedCallable().futureCall(request);
+   *   // Do something.
+   *   for (InstanceConfig element : future.get().iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
*/ public final UnaryCallable listInstanceConfigsPagedCallable() { @@ -253,6 +315,24 @@ public final ListInstanceConfigsPagedResponse listInstanceConfigs( * Lists the supported instance configurations for a given project. * *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   while (true) {
+   *     ListInstanceConfigsResponse response =
+   *         instanceAdminClient.listInstanceConfigsCallable().call(request);
+   *     for (InstanceConfig element : response.getResponsesList()) {
+   *       // doThingsWith(element);
+   *     }
+   *     String nextPageToken = response.getNextPageToken();
+   *     if (!Strings.isNullOrEmpty(nextPageToken)) {
+   *       request = request.toBuilder().setPageToken(nextPageToken).build();
+   *     } else {
+   *       break;
+   *     }
+   *   }
+   * }
+   * }
*/ public final UnaryCallable listInstanceConfigsCallable() { @@ -263,6 +343,15 @@ public final ListInstanceConfigsPagedResponse listInstanceConfigs( /** * Gets information about a particular instance configuration. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   InstanceConfigName name = InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]");
+   *   InstanceConfig response = instanceAdminClient.getInstanceConfig(name);
+   * }
+   * }
+ * * @param name Required. The name of the requested instance configuration. Values are of the form * `projects/<project>/instanceConfigs/<config>`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -279,6 +368,15 @@ public final InstanceConfig getInstanceConfig(InstanceConfigName name) { /** * Gets information about a particular instance configuration. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   String name = InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]").toString();
+   *   InstanceConfig response = instanceAdminClient.getInstanceConfig(name);
+   * }
+   * }
+ * * @param name Required. The name of the requested instance configuration. Values are of the form * `projects/<project>/instanceConfigs/<config>`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -292,6 +390,18 @@ public final InstanceConfig getInstanceConfig(String name) { /** * Gets information about a particular instance configuration. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   GetInstanceConfigRequest request =
+   *       GetInstanceConfigRequest.newBuilder()
+   *           .setName(InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]").toString())
+   *           .build();
+   *   InstanceConfig response = instanceAdminClient.getInstanceConfig(request);
+   * }
+   * }
+ * * @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 */ @@ -304,6 +414,19 @@ public final InstanceConfig getInstanceConfig(GetInstanceConfigRequest request) * Gets information about a particular instance configuration. * *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   GetInstanceConfigRequest request =
+   *       GetInstanceConfigRequest.newBuilder()
+   *           .setName(InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]").toString())
+   *           .build();
+   *   ApiFuture future =
+   *       instanceAdminClient.getInstanceConfigCallable().futureCall(request);
+   *   // Do something.
+   *   InstanceConfig response = future.get();
+   * }
+   * }
*/ public final UnaryCallable getInstanceConfigCallable() { return stub.getInstanceConfigCallable(); @@ -313,6 +436,17 @@ public final UnaryCallable getInstance /** * Lists all instances in the given project. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   ProjectName parent = ProjectName.of("[PROJECT]");
+   *   for (Instance element : instanceAdminClient.listInstances(parent).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @param parent Required. The name of the project for which a list of instances is requested. * Values are of the form `projects/<project>`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -329,6 +463,17 @@ public final ListInstancesPagedResponse listInstances(ProjectName parent) { /** * Lists all instances in the given project. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   String parent = ProjectName.of("[PROJECT]").toString();
+   *   for (Instance element : instanceAdminClient.listInstances(parent).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @param parent Required. The name of the project for which a list of instances is requested. * Values are of the form `projects/<project>`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -342,6 +487,23 @@ public final ListInstancesPagedResponse listInstances(String parent) { /** * Lists all instances in the given project. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   ListInstancesRequest request =
+   *       ListInstancesRequest.newBuilder()
+   *           .setParent(ProjectName.of("[PROJECT]").toString())
+   *           .setPageSize(883849137)
+   *           .setPageToken("pageToken873572522")
+   *           .setFilter("filter-1274492040")
+   *           .build();
+   *   for (Instance element : instanceAdminClient.listInstances(request).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @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 */ @@ -354,6 +516,24 @@ public final ListInstancesPagedResponse listInstances(ListInstancesRequest reque * Lists all instances in the given project. * *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   ListInstancesRequest request =
+   *       ListInstancesRequest.newBuilder()
+   *           .setParent(ProjectName.of("[PROJECT]").toString())
+   *           .setPageSize(883849137)
+   *           .setPageToken("pageToken873572522")
+   *           .setFilter("filter-1274492040")
+   *           .build();
+   *   ApiFuture future =
+   *       instanceAdminClient.listInstancesPagedCallable().futureCall(request);
+   *   // Do something.
+   *   for (Instance element : future.get().iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
*/ public final UnaryCallable listInstancesPagedCallable() { @@ -365,6 +545,23 @@ public final ListInstancesPagedResponse listInstances(ListInstancesRequest reque * Lists all instances in the given project. * *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   while (true) {
+   *     ListInstancesResponse response = instanceAdminClient.listInstancesCallable().call(request);
+   *     for (Instance element : response.getResponsesList()) {
+   *       // doThingsWith(element);
+   *     }
+   *     String nextPageToken = response.getNextPageToken();
+   *     if (!Strings.isNullOrEmpty(nextPageToken)) {
+   *       request = request.toBuilder().setPageToken(nextPageToken).build();
+   *     } else {
+   *       break;
+   *     }
+   *   }
+   * }
+   * }
*/ public final UnaryCallable listInstancesCallable() { return stub.listInstancesCallable(); @@ -374,6 +571,15 @@ public final UnaryCallable listInst /** * Gets information about a particular instance. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   InstanceName name = InstanceName.of("[PROJECT]", "[INSTANCE]");
+   *   Instance response = instanceAdminClient.getInstance(name);
+   * }
+   * }
+ * * @param name Required. The name of the requested instance. Values are of the form * `projects/<project>/instances/<instance>`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -388,6 +594,15 @@ public final Instance getInstance(InstanceName name) { /** * Gets information about a particular instance. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   String name = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
+   *   Instance response = instanceAdminClient.getInstance(name);
+   * }
+   * }
+ * * @param name Required. The name of the requested instance. Values are of the form * `projects/<project>/instances/<instance>`. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -401,6 +616,19 @@ public final Instance getInstance(String name) { /** * Gets information about a particular instance. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   GetInstanceRequest request =
+   *       GetInstanceRequest.newBuilder()
+   *           .setName(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+   *           .setFieldMask(FieldMask.newBuilder().build())
+   *           .build();
+   *   Instance response = instanceAdminClient.getInstance(request);
+   * }
+   * }
+ * * @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 */ @@ -413,6 +641,19 @@ public final Instance getInstance(GetInstanceRequest request) { * Gets information about a particular instance. * *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   GetInstanceRequest request =
+   *       GetInstanceRequest.newBuilder()
+   *           .setName(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+   *           .setFieldMask(FieldMask.newBuilder().build())
+   *           .build();
+   *   ApiFuture future = instanceAdminClient.getInstanceCallable().futureCall(request);
+   *   // Do something.
+   *   Instance response = future.get();
+   * }
+   * }
*/ public final UnaryCallable getInstanceCallable() { return stub.getInstanceCallable(); @@ -450,6 +691,18 @@ public final UnaryCallable getInstanceCallable() { * [response][google.longrunning.Operation.response] field type is * [Instance][google.spanner.admin.instance.v1.Instance], if successful. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   ProjectName parent = ProjectName.of("[PROJECT]");
+   *   String instanceId = "instanceId902024336";
+   *   Instance instance = Instance.newBuilder().build();
+   *   Instance response =
+   *       instanceAdminClient.createInstanceAsync(parent, instanceId, instance).get();
+   * }
+   * }
+ * * @param parent Required. The name of the project in which to create the instance. Values are of * the form `projects/<project>`. * @param instanceId Required. The ID of the instance to create. Valid identifiers are of the form @@ -501,6 +754,18 @@ public final OperationFuture createInstanceAsy * [response][google.longrunning.Operation.response] field type is * [Instance][google.spanner.admin.instance.v1.Instance], if successful. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   String parent = ProjectName.of("[PROJECT]").toString();
+   *   String instanceId = "instanceId902024336";
+   *   Instance instance = Instance.newBuilder().build();
+   *   Instance response =
+   *       instanceAdminClient.createInstanceAsync(parent, instanceId, instance).get();
+   * }
+   * }
+ * * @param parent Required. The name of the project in which to create the instance. Values are of * the form `projects/<project>`. * @param instanceId Required. The ID of the instance to create. Valid identifiers are of the form @@ -552,6 +817,20 @@ public final OperationFuture createInstanceAsy * [response][google.longrunning.Operation.response] field type is * [Instance][google.spanner.admin.instance.v1.Instance], if successful. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   CreateInstanceRequest request =
+   *       CreateInstanceRequest.newBuilder()
+   *           .setParent(ProjectName.of("[PROJECT]").toString())
+   *           .setInstanceId("instanceId902024336")
+   *           .setInstance(Instance.newBuilder().build())
+   *           .build();
+   *   Instance response = instanceAdminClient.createInstanceAsync(request).get();
+   * }
+   * }
+ * * @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 */ @@ -593,6 +872,21 @@ public final OperationFuture createInstanceAsy * [Instance][google.spanner.admin.instance.v1.Instance], if successful. * *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   CreateInstanceRequest request =
+   *       CreateInstanceRequest.newBuilder()
+   *           .setParent(ProjectName.of("[PROJECT]").toString())
+   *           .setInstanceId("instanceId902024336")
+   *           .setInstance(Instance.newBuilder().build())
+   *           .build();
+   *   OperationFuture future =
+   *       instanceAdminClient.createInstanceOperationCallable().futureCall(request);
+   *   // Do something.
+   *   Instance response = future.get();
+   * }
+   * }
*/ public final OperationCallable createInstanceOperationCallable() { @@ -632,6 +926,21 @@ public final OperationFuture createInstanceAsy * [Instance][google.spanner.admin.instance.v1.Instance], if successful. * *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   CreateInstanceRequest request =
+   *       CreateInstanceRequest.newBuilder()
+   *           .setParent(ProjectName.of("[PROJECT]").toString())
+   *           .setInstanceId("instanceId902024336")
+   *           .setInstance(Instance.newBuilder().build())
+   *           .build();
+   *   ApiFuture future =
+   *       instanceAdminClient.createInstanceCallable().futureCall(request);
+   *   // Do something.
+   *   Operation response = future.get();
+   * }
+   * }
*/ public final UnaryCallable createInstanceCallable() { return stub.createInstanceCallable(); @@ -673,6 +982,16 @@ public final UnaryCallable createInstanceCalla *

Authorization requires `spanner.instances.update` permission on resource * [name][google.spanner.admin.instance.v1.Instance.name]. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   Instance instance = Instance.newBuilder().build();
+   *   FieldMask fieldMask = FieldMask.newBuilder().build();
+   *   Instance response = instanceAdminClient.updateInstanceAsync(instance, fieldMask).get();
+   * }
+   * }
+ * * @param instance Required. The instance to update, which must always include the instance name. * Otherwise, only fields mentioned in * [field_mask][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be @@ -727,6 +1046,19 @@ public final OperationFuture updateInstanceAsy *

Authorization requires `spanner.instances.update` permission on resource * [name][google.spanner.admin.instance.v1.Instance.name]. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   UpdateInstanceRequest request =
+   *       UpdateInstanceRequest.newBuilder()
+   *           .setInstance(Instance.newBuilder().build())
+   *           .setFieldMask(FieldMask.newBuilder().build())
+   *           .build();
+   *   Instance response = instanceAdminClient.updateInstanceAsync(request).get();
+   * }
+   * }
+ * * @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 */ @@ -772,6 +1104,20 @@ public final OperationFuture updateInstanceAsy * [name][google.spanner.admin.instance.v1.Instance.name]. * *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   UpdateInstanceRequest request =
+   *       UpdateInstanceRequest.newBuilder()
+   *           .setInstance(Instance.newBuilder().build())
+   *           .setFieldMask(FieldMask.newBuilder().build())
+   *           .build();
+   *   OperationFuture future =
+   *       instanceAdminClient.updateInstanceOperationCallable().futureCall(request);
+   *   // Do something.
+   *   Instance response = future.get();
+   * }
+   * }
*/ public final OperationCallable updateInstanceOperationCallable() { @@ -815,6 +1161,20 @@ public final OperationFuture updateInstanceAsy * [name][google.spanner.admin.instance.v1.Instance.name]. * *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   UpdateInstanceRequest request =
+   *       UpdateInstanceRequest.newBuilder()
+   *           .setInstance(Instance.newBuilder().build())
+   *           .setFieldMask(FieldMask.newBuilder().build())
+   *           .build();
+   *   ApiFuture future =
+   *       instanceAdminClient.updateInstanceCallable().futureCall(request);
+   *   // Do something.
+   *   Operation response = future.get();
+   * }
+   * }
*/ public final UnaryCallable updateInstanceCallable() { return stub.updateInstanceCallable(); @@ -833,6 +1193,15 @@ public final UnaryCallable updateInstanceCalla *

* The instance and *all of its databases* immediately and irrevocably disappear * from the API. All data in the databases is permanently deleted. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   InstanceName name = InstanceName.of("[PROJECT]", "[INSTANCE]");
+   *   instanceAdminClient.deleteInstance(name);
+   * }
+   * }
+ * * @param name Required. The name of the instance to be deleted. Values are of the form * `projects/<project>/instances/<instance>` * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -856,6 +1225,15 @@ public final void deleteInstance(InstanceName name) { *

* The instance and *all of its databases* immediately and irrevocably disappear * from the API. All data in the databases is permanently deleted. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   String name = InstanceName.of("[PROJECT]", "[INSTANCE]").toString();
+   *   instanceAdminClient.deleteInstance(name);
+   * }
+   * }
+ * * @param name Required. The name of the instance to be deleted. Values are of the form * `projects/<project>/instances/<instance>` * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -878,6 +1256,18 @@ public final void deleteInstance(String name) { *

* The instance and *all of its databases* immediately and irrevocably disappear * from the API. All data in the databases is permanently deleted. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   DeleteInstanceRequest request =
+   *       DeleteInstanceRequest.newBuilder()
+   *           .setName(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+   *           .build();
+   *   instanceAdminClient.deleteInstance(request);
+   * }
+   * }
+ * * @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 */ @@ -899,6 +1289,18 @@ public final void deleteInstance(DeleteInstanceRequest request) { * from the API. All data in the databases is permanently deleted. * *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   DeleteInstanceRequest request =
+   *       DeleteInstanceRequest.newBuilder()
+   *           .setName(InstanceName.of("[PROJECT]", "[INSTANCE]").toString())
+   *           .build();
+   *   ApiFuture future = instanceAdminClient.deleteInstanceCallable().futureCall(request);
+   *   // Do something.
+   *   future.get();
+   * }
+   * }
*/ public final UnaryCallable deleteInstanceCallable() { return stub.deleteInstanceCallable(); @@ -911,6 +1313,16 @@ public final UnaryCallable deleteInstanceCallable( *

Authorization requires `spanner.instances.setIamPolicy` on * [resource][google.iam.v1.SetIamPolicyRequest.resource]. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   ResourceName resource = ProjectName.of("[PROJECT]");
+   *   Policy policy = Policy.newBuilder().build();
+   *   Policy response = instanceAdminClient.setIamPolicy(resource, policy);
+   * }
+   * }
+ * * @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 @@ -934,6 +1346,16 @@ public final Policy setIamPolicy(ResourceName resource, Policy policy) { *

Authorization requires `spanner.instances.setIamPolicy` on * [resource][google.iam.v1.SetIamPolicyRequest.resource]. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   String resource = ProjectName.of("[PROJECT]").toString();
+   *   Policy policy = Policy.newBuilder().build();
+   *   Policy response = instanceAdminClient.setIamPolicy(resource, policy);
+   * }
+   * }
+ * * @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 @@ -954,6 +1376,19 @@ public final Policy setIamPolicy(String resource, Policy policy) { *

Authorization requires `spanner.instances.setIamPolicy` on * [resource][google.iam.v1.SetIamPolicyRequest.resource]. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   SetIamPolicyRequest request =
+   *       SetIamPolicyRequest.newBuilder()
+   *           .setResource(ProjectName.of("[PROJECT]").toString())
+   *           .setPolicy(Policy.newBuilder().build())
+   *           .build();
+   *   Policy response = instanceAdminClient.setIamPolicy(request);
+   * }
+   * }
+ * * @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 */ @@ -969,6 +1404,19 @@ public final Policy setIamPolicy(SetIamPolicyRequest request) { * [resource][google.iam.v1.SetIamPolicyRequest.resource]. * *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   SetIamPolicyRequest request =
+   *       SetIamPolicyRequest.newBuilder()
+   *           .setResource(ProjectName.of("[PROJECT]").toString())
+   *           .setPolicy(Policy.newBuilder().build())
+   *           .build();
+   *   ApiFuture future = instanceAdminClient.setIamPolicyCallable().futureCall(request);
+   *   // Do something.
+   *   Policy response = future.get();
+   * }
+   * }
*/ public final UnaryCallable setIamPolicyCallable() { return stub.setIamPolicyCallable(); @@ -982,6 +1430,15 @@ public final UnaryCallable setIamPolicyCallable() { *

Authorization requires `spanner.instances.getIamPolicy` on * [resource][google.iam.v1.GetIamPolicyRequest.resource]. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   ResourceName resource = ProjectName.of("[PROJECT]");
+   *   Policy response = instanceAdminClient.getIamPolicy(resource);
+   * }
+   * }
+ * * @param resource REQUIRED: The resource for which the policy is being requested. See the * operation documentation for the appropriate value for this field. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -1002,6 +1459,15 @@ public final Policy getIamPolicy(ResourceName resource) { *

Authorization requires `spanner.instances.getIamPolicy` on * [resource][google.iam.v1.GetIamPolicyRequest.resource]. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   String resource = ProjectName.of("[PROJECT]").toString();
+   *   Policy response = instanceAdminClient.getIamPolicy(resource);
+   * }
+   * }
+ * * @param resource REQUIRED: The resource for which the policy is being requested. See the * operation documentation for the appropriate value for this field. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -1019,6 +1485,19 @@ public final Policy getIamPolicy(String resource) { *

Authorization requires `spanner.instances.getIamPolicy` on * [resource][google.iam.v1.GetIamPolicyRequest.resource]. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   GetIamPolicyRequest request =
+   *       GetIamPolicyRequest.newBuilder()
+   *           .setResource(ProjectName.of("[PROJECT]").toString())
+   *           .setOptions(GetPolicyOptions.newBuilder().build())
+   *           .build();
+   *   Policy response = instanceAdminClient.getIamPolicy(request);
+   * }
+   * }
+ * * @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 */ @@ -1035,6 +1514,19 @@ public final Policy getIamPolicy(GetIamPolicyRequest request) { * [resource][google.iam.v1.GetIamPolicyRequest.resource]. * *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   GetIamPolicyRequest request =
+   *       GetIamPolicyRequest.newBuilder()
+   *           .setResource(ProjectName.of("[PROJECT]").toString())
+   *           .setOptions(GetPolicyOptions.newBuilder().build())
+   *           .build();
+   *   ApiFuture future = instanceAdminClient.getIamPolicyCallable().futureCall(request);
+   *   // Do something.
+   *   Policy response = future.get();
+   * }
+   * }
*/ public final UnaryCallable getIamPolicyCallable() { return stub.getIamPolicyCallable(); @@ -1048,6 +1540,17 @@ public final UnaryCallable getIamPolicyCallable() { * NOT_FOUND error if the user has `spanner.instances.list` permission on the containing Google * Cloud Project. Otherwise returns an empty set of permissions. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   ResourceName resource = ProjectName.of("[PROJECT]");
+   *   List permissions = new ArrayList<>();
+   *   TestIamPermissionsResponse response =
+   *       instanceAdminClient.testIamPermissions(resource, permissions);
+   * }
+   * }
+ * * @param resource REQUIRED: The resource for which the policy detail is being requested. See the * operation documentation for the appropriate value for this field. * @param permissions The set of permissions to check for the `resource`. Permissions with @@ -1073,6 +1576,17 @@ public final TestIamPermissionsResponse testIamPermissions( * NOT_FOUND error if the user has `spanner.instances.list` permission on the containing Google * Cloud Project. Otherwise returns an empty set of permissions. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   String resource = ProjectName.of("[PROJECT]").toString();
+   *   List permissions = new ArrayList<>();
+   *   TestIamPermissionsResponse response =
+   *       instanceAdminClient.testIamPermissions(resource, permissions);
+   * }
+   * }
+ * * @param resource REQUIRED: The resource for which the policy detail is being requested. See the * operation documentation for the appropriate value for this field. * @param permissions The set of permissions to check for the `resource`. Permissions with @@ -1098,6 +1612,19 @@ public final TestIamPermissionsResponse testIamPermissions( * NOT_FOUND error if the user has `spanner.instances.list` permission on the containing Google * Cloud Project. Otherwise returns an empty set of permissions. * + *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   TestIamPermissionsRequest request =
+   *       TestIamPermissionsRequest.newBuilder()
+   *           .setResource(ProjectName.of("[PROJECT]").toString())
+   *           .addAllPermissions(new ArrayList())
+   *           .build();
+   *   TestIamPermissionsResponse response = instanceAdminClient.testIamPermissions(request);
+   * }
+   * }
+ * * @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 */ @@ -1114,6 +1641,20 @@ public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsReq * Cloud Project. Otherwise returns an empty set of permissions. * *

Sample code: + * + * 

{@code
+   * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+   *   TestIamPermissionsRequest request =
+   *       TestIamPermissionsRequest.newBuilder()
+   *           .setResource(ProjectName.of("[PROJECT]").toString())
+   *           .addAllPermissions(new ArrayList())
+   *           .build();
+   *   ApiFuture future =
+   *       instanceAdminClient.testIamPermissionsCallable().futureCall(request);
+   *   // Do something.
+   *   TestIamPermissionsResponse response = future.get();
+   * }
+   * }
*/ public final UnaryCallable testIamPermissionsCallable() { diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/instance/v1/package-info.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/instance/v1/package-info.java index 189e53a2d6..19b1d13aca 100644 --- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/instance/v1/package-info.java +++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/admin/instance/v1/package-info.java @@ -38,6 +38,13 @@ * databases in that instance, and their performance may suffer. * *

Sample for InstanceAdminClient: + * + * 

{@code
+ * try (InstanceAdminClient instanceAdminClient = InstanceAdminClient.create()) {
+ *   InstanceConfigName name = InstanceConfigName.of("[PROJECT]", "[INSTANCE_CONFIG]");
+ *   InstanceConfig response = instanceAdminClient.getInstanceConfig(name);
+ * }
+ * }
*/ @Generated("by gapic-generator-java") package com.google.cloud.spanner.admin.instance.v1; diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/v1/SpannerClient.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/v1/SpannerClient.java index 2c430faaad..c05c3d5ee9 100644 --- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/v1/SpannerClient.java +++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/v1/SpannerClient.java @@ -73,6 +73,13 @@ *

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: * + * 

{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ *   DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+ *   Session response = spannerClient.createSession(database);
+ * }
+ * }
+ * *

Note: close() needs to be called on the SpannerClient object to clean up resources such as * threads. In the example above, try-with-resources is used, which automatically calls close(). * @@ -187,6 +194,15 @@ public SpannerStub getStub() { *

Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `"SELECT * 1"`. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+   *   Session response = spannerClient.createSession(database);
+   * }
+   * }
+ * * @param database Required. The database in which the new session is created. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -216,6 +232,15 @@ public final Session createSession(DatabaseName database) { *

Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `"SELECT * 1"`. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
+   *   Session response = spannerClient.createSession(database);
+   * }
+   * }
+ * * @param database Required. The database in which the new session is created. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -242,6 +267,19 @@ public final Session createSession(String database) { *

Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `"SELECT * 1"`. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   CreateSessionRequest request =
+   *       CreateSessionRequest.newBuilder()
+   *           .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+   *           .setSession(Session.newBuilder().build())
+   *           .build();
+   *   Session response = spannerClient.createSession(request);
+   * }
+   * }
+ * * @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 */ @@ -268,6 +306,19 @@ public final Session createSession(CreateSessionRequest request) { * 1"`. * *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   CreateSessionRequest request =
+   *       CreateSessionRequest.newBuilder()
+   *           .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+   *           .setSession(Session.newBuilder().build())
+   *           .build();
+   *   ApiFuture future = spannerClient.createSessionCallable().futureCall(request);
+   *   // Do something.
+   *   Session response = future.get();
+   * }
+   * }
*/ public final UnaryCallable createSessionCallable() { return stub.createSessionCallable(); @@ -280,6 +331,17 @@ public final UnaryCallable createSessionCallable( *

This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 * for best practices on session cache management. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+   *   int sessionCount = 185691686;
+   *   BatchCreateSessionsResponse response =
+   *       spannerClient.batchCreateSessions(database, sessionCount);
+   * }
+   * }
+ * * @param database Required. The database in which the new sessions are created. * @param sessionCount Required. The number of sessions to be created in this batch call. The API * may return fewer than the requested number of sessions. If a specific number of sessions @@ -304,6 +366,17 @@ public final BatchCreateSessionsResponse batchCreateSessions( *

This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 * for best practices on session cache management. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
+   *   int sessionCount = 185691686;
+   *   BatchCreateSessionsResponse response =
+   *       spannerClient.batchCreateSessions(database, sessionCount);
+   * }
+   * }
+ * * @param database Required. The database in which the new sessions are created. * @param sessionCount Required. The number of sessions to be created in this batch call. The API * may return fewer than the requested number of sessions. If a specific number of sessions @@ -327,6 +400,20 @@ public final BatchCreateSessionsResponse batchCreateSessions(String database, in *

This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 * for best practices on session cache management. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   BatchCreateSessionsRequest request =
+   *       BatchCreateSessionsRequest.newBuilder()
+   *           .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+   *           .setSessionTemplate(Session.newBuilder().build())
+   *           .setSessionCount(185691686)
+   *           .build();
+   *   BatchCreateSessionsResponse response = spannerClient.batchCreateSessions(request);
+   * }
+   * }
+ * * @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 */ @@ -342,6 +429,21 @@ public final BatchCreateSessionsResponse batchCreateSessions(BatchCreateSessions * for best practices on session cache management. * *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   BatchCreateSessionsRequest request =
+   *       BatchCreateSessionsRequest.newBuilder()
+   *           .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+   *           .setSessionTemplate(Session.newBuilder().build())
+   *           .setSessionCount(185691686)
+   *           .build();
+   *   ApiFuture future =
+   *       spannerClient.batchCreateSessionsCallable().futureCall(request);
+   *   // Do something.
+   *   BatchCreateSessionsResponse response = future.get();
+   * }
+   * }
*/ public final UnaryCallable batchCreateSessionsCallable() { @@ -353,6 +455,15 @@ public final BatchCreateSessionsResponse batchCreateSessions(BatchCreateSessions * Gets a session. Returns `NOT_FOUND` if the session does not exist. This is mainly useful for * determining whether a session is still alive. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   SessionName name = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
+   *   Session response = spannerClient.getSession(name);
+   * }
+   * }
+ * * @param name Required. The name of the session to retrieve. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -367,6 +478,15 @@ public final Session getSession(SessionName name) { * Gets a session. Returns `NOT_FOUND` if the session does not exist. This is mainly useful for * determining whether a session is still alive. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   String name = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
+   *   Session response = spannerClient.getSession(name);
+   * }
+   * }
+ * * @param name Required. The name of the session to retrieve. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -380,6 +500,19 @@ public final Session getSession(String name) { * Gets a session. Returns `NOT_FOUND` if the session does not exist. This is mainly useful for * determining whether a session is still alive. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   GetSessionRequest request =
+   *       GetSessionRequest.newBuilder()
+   *           .setName(
+   *               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+   *           .build();
+   *   Session response = spannerClient.getSession(request);
+   * }
+   * }
+ * * @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 */ @@ -393,6 +526,19 @@ public final Session getSession(GetSessionRequest request) { * determining whether a session is still alive. * *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   GetSessionRequest request =
+   *       GetSessionRequest.newBuilder()
+   *           .setName(
+   *               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+   *           .build();
+   *   ApiFuture future = spannerClient.getSessionCallable().futureCall(request);
+   *   // Do something.
+   *   Session response = future.get();
+   * }
+   * }
*/ public final UnaryCallable getSessionCallable() { return stub.getSessionCallable(); @@ -402,6 +548,17 @@ public final UnaryCallable getSessionCallable() { /** * Lists all sessions in a given database. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+   *   for (Session element : spannerClient.listSessions(database).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @param database Required. The database in which to list sessions. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -417,6 +574,17 @@ public final ListSessionsPagedResponse listSessions(DatabaseName database) { /** * Lists all sessions in a given database. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   String database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString();
+   *   for (Session element : spannerClient.listSessions(database).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @param database Required. The database in which to list sessions. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -429,6 +597,23 @@ public final ListSessionsPagedResponse listSessions(String database) { /** * Lists all sessions in a given database. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   ListSessionsRequest request =
+   *       ListSessionsRequest.newBuilder()
+   *           .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+   *           .setPageSize(883849137)
+   *           .setPageToken("pageToken873572522")
+   *           .setFilter("filter-1274492040")
+   *           .build();
+   *   for (Session element : spannerClient.listSessions(request).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
+ * * @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 */ @@ -441,6 +626,23 @@ public final ListSessionsPagedResponse listSessions(ListSessionsRequest request) * Lists all sessions in a given database. * *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   ListSessionsRequest request =
+   *       ListSessionsRequest.newBuilder()
+   *           .setDatabase(DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]").toString())
+   *           .setPageSize(883849137)
+   *           .setPageToken("pageToken873572522")
+   *           .setFilter("filter-1274492040")
+   *           .build();
+   *   ApiFuture future = spannerClient.listSessionsPagedCallable().futureCall(request);
+   *   // Do something.
+   *   for (Session element : future.get().iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }
*/ public final UnaryCallable listSessionsPagedCallable() { @@ -452,6 +654,23 @@ public final ListSessionsPagedResponse listSessions(ListSessionsRequest request) * Lists all sessions in a given database. * *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   while (true) {
+   *     ListSessionsResponse response = spannerClient.listSessionsCallable().call(request);
+   *     for (Session element : response.getResponsesList()) {
+   *       // doThingsWith(element);
+   *     }
+   *     String nextPageToken = response.getNextPageToken();
+   *     if (!Strings.isNullOrEmpty(nextPageToken)) {
+   *       request = request.toBuilder().setPageToken(nextPageToken).build();
+   *     } else {
+   *       break;
+   *     }
+   *   }
+   * }
+   * }
*/ public final UnaryCallable listSessionsCallable() { return stub.listSessionsCallable(); @@ -462,6 +681,15 @@ public final UnaryCallable listSessio * Ends a session, releasing server resources associated with it. This will asynchronously trigger * cancellation of any operations that are running with this session. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   SessionName name = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
+   *   spannerClient.deleteSession(name);
+   * }
+   * }
+ * * @param name Required. The name of the session to delete. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -476,6 +704,15 @@ public final void deleteSession(SessionName name) { * Ends a session, releasing server resources associated with it. This will asynchronously trigger * cancellation of any operations that are running with this session. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   String name = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
+   *   spannerClient.deleteSession(name);
+   * }
+   * }
+ * * @param name Required. The name of the session to delete. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -489,6 +726,19 @@ public final void deleteSession(String name) { * Ends a session, releasing server resources associated with it. This will asynchronously trigger * cancellation of any operations that are running with this session. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   DeleteSessionRequest request =
+   *       DeleteSessionRequest.newBuilder()
+   *           .setName(
+   *               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+   *           .build();
+   *   spannerClient.deleteSession(request);
+   * }
+   * }
+ * * @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 */ @@ -502,6 +752,19 @@ public final void deleteSession(DeleteSessionRequest request) { * cancellation of any operations that are running with this session. * *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   DeleteSessionRequest request =
+   *       DeleteSessionRequest.newBuilder()
+   *           .setName(
+   *               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+   *           .build();
+   *   ApiFuture future = spannerClient.deleteSessionCallable().futureCall(request);
+   *   // Do something.
+   *   future.get();
+   * }
+   * }
*/ public final UnaryCallable deleteSessionCallable() { return stub.deleteSessionCallable(); @@ -520,6 +783,27 @@ public final UnaryCallable deleteSessionCallable() *

Larger result sets can be fetched in streaming fashion by calling * [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] instead. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   ExecuteSqlRequest request =
+   *       ExecuteSqlRequest.newBuilder()
+   *           .setSession(
+   *               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+   *           .setTransaction(TransactionSelector.newBuilder().build())
+   *           .setSql("sql114126")
+   *           .setParams(Struct.newBuilder().build())
+   *           .putAllParamTypes(new HashMap())
+   *           .setResumeToken(ByteString.EMPTY)
+   *           .setPartitionToken(ByteString.EMPTY)
+   *           .setSeqno(109325920)
+   *           .setQueryOptions(ExecuteSqlRequest.QueryOptions.newBuilder().build())
+   *           .build();
+   *   ResultSet response = spannerClient.executeSql(request);
+   * }
+   * }
+ * * @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 */ @@ -541,6 +825,27 @@ public final ResultSet executeSql(ExecuteSqlRequest request) { * [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] instead. * *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   ExecuteSqlRequest request =
+   *       ExecuteSqlRequest.newBuilder()
+   *           .setSession(
+   *               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+   *           .setTransaction(TransactionSelector.newBuilder().build())
+   *           .setSql("sql114126")
+   *           .setParams(Struct.newBuilder().build())
+   *           .putAllParamTypes(new HashMap())
+   *           .setResumeToken(ByteString.EMPTY)
+   *           .setPartitionToken(ByteString.EMPTY)
+   *           .setSeqno(109325920)
+   *           .setQueryOptions(ExecuteSqlRequest.QueryOptions.newBuilder().build())
+   *           .build();
+   *   ApiFuture future = spannerClient.executeSqlCallable().futureCall(request);
+   *   // Do something.
+   *   ResultSet response = future.get();
+   * }
+   * }
*/ public final UnaryCallable executeSqlCallable() { return stub.executeSqlCallable(); @@ -554,6 +859,29 @@ public final UnaryCallable executeSqlCallable() { * MiB, and no column value can exceed 10 MiB. * *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   ExecuteSqlRequest request =
+   *       ExecuteSqlRequest.newBuilder()
+   *           .setSession(
+   *               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+   *           .setTransaction(TransactionSelector.newBuilder().build())
+   *           .setSql("sql114126")
+   *           .setParams(Struct.newBuilder().build())
+   *           .putAllParamTypes(new HashMap())
+   *           .setResumeToken(ByteString.EMPTY)
+   *           .setPartitionToken(ByteString.EMPTY)
+   *           .setSeqno(109325920)
+   *           .setQueryOptions(ExecuteSqlRequest.QueryOptions.newBuilder().build())
+   *           .build();
+   *   ServerStream stream =
+   *       spannerClient.executeStreamingSqlCallable().call(request);
+   *   for (PartialResultSet response : stream) {
+   *     // Do something when a response is received.
+   *   }
+   * }
+   * }
*/ public final ServerStreamingCallable executeStreamingSqlCallable() { @@ -573,6 +901,22 @@ public final UnaryCallable executeSqlCallable() { * *

Execution stops after the first failed statement; the remaining statements are not executed. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   ExecuteBatchDmlRequest request =
+   *       ExecuteBatchDmlRequest.newBuilder()
+   *           .setSession(
+   *               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+   *           .setTransaction(TransactionSelector.newBuilder().build())
+   *           .addAllStatements(new ArrayList())
+   *           .setSeqno(109325920)
+   *           .build();
+   *   ExecuteBatchDmlResponse response = spannerClient.executeBatchDml(request);
+   * }
+   * }
+ * * @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 */ @@ -594,6 +938,23 @@ public final ExecuteBatchDmlResponse executeBatchDml(ExecuteBatchDmlRequest requ *

Execution stops after the first failed statement; the remaining statements are not executed. * *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   ExecuteBatchDmlRequest request =
+   *       ExecuteBatchDmlRequest.newBuilder()
+   *           .setSession(
+   *               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+   *           .setTransaction(TransactionSelector.newBuilder().build())
+   *           .addAllStatements(new ArrayList())
+   *           .setSeqno(109325920)
+   *           .build();
+   *   ApiFuture future =
+   *       spannerClient.executeBatchDmlCallable().futureCall(request);
+   *   // Do something.
+   *   ExecuteBatchDmlResponse response = future.get();
+   * }
+   * }
*/ public final UnaryCallable executeBatchDmlCallable() { @@ -614,6 +975,27 @@ public final ExecuteBatchDmlResponse executeBatchDml(ExecuteBatchDmlRequest requ *

Larger result sets can be yielded in streaming fashion by calling * [StreamingRead][google.spanner.v1.Spanner.StreamingRead] instead. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   ReadRequest request =
+   *       ReadRequest.newBuilder()
+   *           .setSession(
+   *               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+   *           .setTransaction(TransactionSelector.newBuilder().build())
+   *           .setTable("table110115790")
+   *           .setIndex("index100346066")
+   *           .addAllColumns(new ArrayList())
+   *           .setKeySet(KeySet.newBuilder().build())
+   *           .setLimit(102976443)
+   *           .setResumeToken(ByteString.EMPTY)
+   *           .setPartitionToken(ByteString.EMPTY)
+   *           .build();
+   *   ResultSet response = spannerClient.read(request);
+   * }
+   * }
+ * * @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 */ @@ -636,6 +1018,27 @@ public final ResultSet read(ReadRequest request) { * [StreamingRead][google.spanner.v1.Spanner.StreamingRead] instead. * *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   ReadRequest request =
+   *       ReadRequest.newBuilder()
+   *           .setSession(
+   *               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+   *           .setTransaction(TransactionSelector.newBuilder().build())
+   *           .setTable("table110115790")
+   *           .setIndex("index100346066")
+   *           .addAllColumns(new ArrayList())
+   *           .setKeySet(KeySet.newBuilder().build())
+   *           .setLimit(102976443)
+   *           .setResumeToken(ByteString.EMPTY)
+   *           .setPartitionToken(ByteString.EMPTY)
+   *           .build();
+   *   ApiFuture future = spannerClient.readCallable().futureCall(request);
+   *   // Do something.
+   *   ResultSet response = future.get();
+   * }
+   * }
*/ public final UnaryCallable readCallable() { return stub.readCallable(); @@ -649,6 +1052,28 @@ public final UnaryCallable readCallable() { * exceed 10 MiB. * *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   ReadRequest request =
+   *       ReadRequest.newBuilder()
+   *           .setSession(
+   *               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+   *           .setTransaction(TransactionSelector.newBuilder().build())
+   *           .setTable("table110115790")
+   *           .setIndex("index100346066")
+   *           .addAllColumns(new ArrayList())
+   *           .setKeySet(KeySet.newBuilder().build())
+   *           .setLimit(102976443)
+   *           .setResumeToken(ByteString.EMPTY)
+   *           .setPartitionToken(ByteString.EMPTY)
+   *           .build();
+   *   ServerStream stream = spannerClient.streamingReadCallable().call(request);
+   *   for (PartialResultSet response : stream) {
+   *     // Do something when a response is received.
+   *   }
+   * }
+   * }
*/ public final ServerStreamingCallable streamingReadCallable() { return stub.streamingReadCallable(); @@ -660,6 +1085,16 @@ public final ServerStreamingCallable streamingRea * [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and * [Commit][google.spanner.v1.Spanner.Commit] can begin a new transaction as a side-effect. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   SessionName session = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
+   *   TransactionOptions options = TransactionOptions.newBuilder().build();
+   *   Transaction response = spannerClient.beginTransaction(session, options);
+   * }
+   * }
+ * * @param session Required. The session in which the transaction runs. * @param options Required. Options for the new transaction. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -679,6 +1114,17 @@ public final Transaction beginTransaction(SessionName session, TransactionOption * [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and * [Commit][google.spanner.v1.Spanner.Commit] can begin a new transaction as a side-effect. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   String session =
+   *       SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
+   *   TransactionOptions options = TransactionOptions.newBuilder().build();
+   *   Transaction response = spannerClient.beginTransaction(session, options);
+   * }
+   * }
+ * * @param session Required. The session in which the transaction runs. * @param options Required. Options for the new transaction. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -695,6 +1141,20 @@ public final Transaction beginTransaction(String session, TransactionOptions opt * [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and * [Commit][google.spanner.v1.Spanner.Commit] can begin a new transaction as a side-effect. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   BeginTransactionRequest request =
+   *       BeginTransactionRequest.newBuilder()
+   *           .setSession(
+   *               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+   *           .setOptions(TransactionOptions.newBuilder().build())
+   *           .build();
+   *   Transaction response = spannerClient.beginTransaction(request);
+   * }
+   * }
+ * * @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 */ @@ -709,6 +1169,20 @@ public final Transaction beginTransaction(BeginTransactionRequest request) { * [Commit][google.spanner.v1.Spanner.Commit] can begin a new transaction as a side-effect. * *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   BeginTransactionRequest request =
+   *       BeginTransactionRequest.newBuilder()
+   *           .setSession(
+   *               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+   *           .setOptions(TransactionOptions.newBuilder().build())
+   *           .build();
+   *   ApiFuture future = spannerClient.beginTransactionCallable().futureCall(request);
+   *   // Do something.
+   *   Transaction response = future.get();
+   * }
+   * }
*/ public final UnaryCallable beginTransactionCallable() { return stub.beginTransactionCallable(); @@ -729,6 +1203,17 @@ public final UnaryCallable beginTransactio * track of the transaction outcome and we recommend that you perform another read from the * database to see the state of things as they are now. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   SessionName session = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
+   *   ByteString transactionId = ByteString.EMPTY;
+   *   List mutations = new ArrayList<>();
+   *   CommitResponse response = spannerClient.commit(session, transactionId, mutations);
+   * }
+   * }
+ * * @param session Required. The session in which the transaction to be committed is running. * @param transactionId Commit a previously-started transaction. * @param mutations The mutations to be executed when this transaction commits. All mutations are @@ -761,6 +1246,17 @@ public final CommitResponse commit( * track of the transaction outcome and we recommend that you perform another read from the * database to see the state of things as they are now. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   SessionName session = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
+   *   TransactionOptions singleUseTransaction = TransactionOptions.newBuilder().build();
+   *   List mutations = new ArrayList<>();
+   *   CommitResponse response = spannerClient.commit(session, singleUseTransaction, mutations);
+   * }
+   * }
+ * * @param session Required. The session in which the transaction to be committed is running. * @param singleUseTransaction Execute mutations in a temporary transaction. Note that unlike * commit of a previously-started transaction, commit with a temporary transaction is @@ -799,6 +1295,18 @@ public final CommitResponse commit( * track of the transaction outcome and we recommend that you perform another read from the * database to see the state of things as they are now. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   String session =
+   *       SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
+   *   ByteString transactionId = ByteString.EMPTY;
+   *   List mutations = new ArrayList<>();
+   *   CommitResponse response = spannerClient.commit(session, transactionId, mutations);
+   * }
+   * }
+ * * @param session Required. The session in which the transaction to be committed is running. * @param transactionId Commit a previously-started transaction. * @param mutations The mutations to be executed when this transaction commits. All mutations are @@ -831,6 +1339,18 @@ public final CommitResponse commit( * track of the transaction outcome and we recommend that you perform another read from the * database to see the state of things as they are now. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   String session =
+   *       SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
+   *   TransactionOptions singleUseTransaction = TransactionOptions.newBuilder().build();
+   *   List mutations = new ArrayList<>();
+   *   CommitResponse response = spannerClient.commit(session, singleUseTransaction, mutations);
+   * }
+   * }
+ * * @param session Required. The session in which the transaction to be committed is running. * @param singleUseTransaction Execute mutations in a temporary transaction. Note that unlike * commit of a previously-started transaction, commit with a temporary transaction is @@ -869,6 +1389,21 @@ public final CommitResponse commit( * track of the transaction outcome and we recommend that you perform another read from the * database to see the state of things as they are now. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   CommitRequest request =
+   *       CommitRequest.newBuilder()
+   *           .setSession(
+   *               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+   *           .addAllMutations(new ArrayList())
+   *           .setReturnCommitStats(true)
+   *           .build();
+   *   CommitResponse response = spannerClient.commit(request);
+   * }
+   * }
+ * * @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 */ @@ -892,6 +1427,21 @@ public final CommitResponse commit(CommitRequest request) { * database to see the state of things as they are now. * *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   CommitRequest request =
+   *       CommitRequest.newBuilder()
+   *           .setSession(
+   *               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+   *           .addAllMutations(new ArrayList())
+   *           .setReturnCommitStats(true)
+   *           .build();
+   *   ApiFuture future = spannerClient.commitCallable().futureCall(request);
+   *   // Do something.
+   *   CommitResponse response = future.get();
+   * }
+   * }
*/ public final UnaryCallable commitCallable() { return stub.commitCallable(); @@ -907,6 +1457,16 @@ public final UnaryCallable commitCallable() { *

`Rollback` returns `OK` if it successfully aborts the transaction, the transaction was * already aborted, or the transaction is not found. `Rollback` never returns `ABORTED`. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   SessionName session = SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]");
+   *   ByteString transactionId = ByteString.EMPTY;
+   *   spannerClient.rollback(session, transactionId);
+   * }
+   * }
+ * * @param session Required. The session in which the transaction to roll back is running. * @param transactionId Required. The transaction to roll back. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -930,6 +1490,17 @@ public final void rollback(SessionName session, ByteString transactionId) { *

`Rollback` returns `OK` if it successfully aborts the transaction, the transaction was * already aborted, or the transaction is not found. `Rollback` never returns `ABORTED`. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   String session =
+   *       SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString();
+   *   ByteString transactionId = ByteString.EMPTY;
+   *   spannerClient.rollback(session, transactionId);
+   * }
+   * }
+ * * @param session Required. The session in which the transaction to roll back is running. * @param transactionId Required. The transaction to roll back. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -950,6 +1521,20 @@ public final void rollback(String session, ByteString transactionId) { *

`Rollback` returns `OK` if it successfully aborts the transaction, the transaction was * already aborted, or the transaction is not found. `Rollback` never returns `ABORTED`. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   RollbackRequest request =
+   *       RollbackRequest.newBuilder()
+   *           .setSession(
+   *               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+   *           .setTransactionId(ByteString.EMPTY)
+   *           .build();
+   *   spannerClient.rollback(request);
+   * }
+   * }
+ * * @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 */ @@ -968,6 +1553,20 @@ public final void rollback(RollbackRequest request) { * already aborted, or the transaction is not found. `Rollback` never returns `ABORTED`. * *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   RollbackRequest request =
+   *       RollbackRequest.newBuilder()
+   *           .setSession(
+   *               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+   *           .setTransactionId(ByteString.EMPTY)
+   *           .build();
+   *   ApiFuture future = spannerClient.rollbackCallable().futureCall(request);
+   *   // Do something.
+   *   future.get();
+   * }
+   * }
*/ public final UnaryCallable rollbackCallable() { return stub.rollbackCallable(); @@ -986,6 +1585,24 @@ public final UnaryCallable rollbackCallable() { * too long, begins a new transaction, or becomes too old. When any of these happen, it is not * possible to resume the query, and the whole operation must be restarted from the beginning. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   PartitionQueryRequest request =
+   *       PartitionQueryRequest.newBuilder()
+   *           .setSession(
+   *               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+   *           .setTransaction(TransactionSelector.newBuilder().build())
+   *           .setSql("sql114126")
+   *           .setParams(Struct.newBuilder().build())
+   *           .putAllParamTypes(new HashMap())
+   *           .setPartitionOptions(PartitionOptions.newBuilder().build())
+   *           .build();
+   *   PartitionResponse response = spannerClient.partitionQuery(request);
+   * }
+   * }
+ * * @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 */ @@ -1007,6 +1624,25 @@ public final PartitionResponse partitionQuery(PartitionQueryRequest request) { * possible to resume the query, and the whole operation must be restarted from the beginning. * *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   PartitionQueryRequest request =
+   *       PartitionQueryRequest.newBuilder()
+   *           .setSession(
+   *               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+   *           .setTransaction(TransactionSelector.newBuilder().build())
+   *           .setSql("sql114126")
+   *           .setParams(Struct.newBuilder().build())
+   *           .putAllParamTypes(new HashMap())
+   *           .setPartitionOptions(PartitionOptions.newBuilder().build())
+   *           .build();
+   *   ApiFuture future =
+   *       spannerClient.partitionQueryCallable().futureCall(request);
+   *   // Do something.
+   *   PartitionResponse response = future.get();
+   * }
+   * }
*/ public final UnaryCallable partitionQueryCallable() { return stub.partitionQueryCallable(); @@ -1026,6 +1662,25 @@ public final UnaryCallable partitionQu * too long, begins a new transaction, or becomes too old. When any of these happen, it is not * possible to resume the read, and the whole operation must be restarted from the beginning. * + *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   PartitionReadRequest request =
+   *       PartitionReadRequest.newBuilder()
+   *           .setSession(
+   *               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+   *           .setTransaction(TransactionSelector.newBuilder().build())
+   *           .setTable("table110115790")
+   *           .setIndex("index100346066")
+   *           .addAllColumns(new ArrayList())
+   *           .setKeySet(KeySet.newBuilder().build())
+   *           .setPartitionOptions(PartitionOptions.newBuilder().build())
+   *           .build();
+   *   PartitionResponse response = spannerClient.partitionRead(request);
+   * }
+   * }
+ * * @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 */ @@ -1048,6 +1703,26 @@ public final PartitionResponse partitionRead(PartitionReadRequest request) { * possible to resume the read, and the whole operation must be restarted from the beginning. * *

Sample code: + * + * 

{@code
+   * try (SpannerClient spannerClient = SpannerClient.create()) {
+   *   PartitionReadRequest request =
+   *       PartitionReadRequest.newBuilder()
+   *           .setSession(
+   *               SessionName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]").toString())
+   *           .setTransaction(TransactionSelector.newBuilder().build())
+   *           .setTable("table110115790")
+   *           .setIndex("index100346066")
+   *           .addAllColumns(new ArrayList())
+   *           .setKeySet(KeySet.newBuilder().build())
+   *           .setPartitionOptions(PartitionOptions.newBuilder().build())
+   *           .build();
+   *   ApiFuture future =
+   *       spannerClient.partitionReadCallable().futureCall(request);
+   *   // Do something.
+   *   PartitionResponse response = future.get();
+   * }
+   * }
*/ public final UnaryCallable partitionReadCallable() { return stub.partitionReadCallable(); diff --git a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/v1/package-info.java b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/v1/package-info.java index 7e442cc8b4..0f340c9469 100644 --- a/google-cloud-spanner/src/main/java/com/google/cloud/spanner/v1/package-info.java +++ b/google-cloud-spanner/src/main/java/com/google/cloud/spanner/v1/package-info.java @@ -25,6 +25,13 @@ * in Cloud Spanner databases. * *

Sample for SpannerClient: + * + * 

{@code
+ * try (SpannerClient spannerClient = SpannerClient.create()) {
+ *   DatabaseName database = DatabaseName.of("[PROJECT]", "[INSTANCE]", "[DATABASE]");
+ *   Session response = spannerClient.createSession(database);
+ * }
+ * }
*/ @Generated("by gapic-generator-java") package com.google.cloud.spanner.v1; diff --git a/synth.metadata b/synth.metadata index 7e28947f74..ec08e646e1 100644 --- a/synth.metadata +++ b/synth.metadata @@ -4,15 +4,15 @@ "git": { "name": ".", "remote": "https://github.com/googleapis/java-spanner.git", - "sha": "2887bbb77141ddc92d8ef79d6221a041b4330999" + "sha": "58cebd85a9d82bd1526b9eae98892181f1a022f1" } }, { "git": { "name": "googleapis", "remote": "https://github.com/googleapis/googleapis.git", - "sha": "30eb779ddcc4f389df34d0802d081ef6c4559d6d", - "internalRef": "354462069" + "sha": "8d8c008e56f1af31d57f75561e0f1848ffb29eeb", + "internalRef": "356341083" } }, {