-
Notifications
You must be signed in to change notification settings - Fork 119
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add Multi Region Encryption samples (#3524)
* docs: add Multi Region Encryption samples * add create backup sample * chore: generate libraries at Wed Dec 4 08:33:54 UTC 2024 * add sample for CopyBackup with multi region encryption keys * add restore backup sample * fix sample * chore: generate libraries at Wed Dec 4 09:25:28 UTC 2024 --------- Co-authored-by: cloud-java-bot <cloud-java-bot@google.com>
- Loading branch information
1 parent
e6884d9
commit 316f971
Showing
5 changed files
with
456 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
125 changes: 125 additions & 0 deletions
125
...es/snippets/src/main/java/com/example/spanner/CopyBackupWithMultiRegionEncryptionKey.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| /* | ||
| * Copyright 2024 Google Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.example.spanner; | ||
|
|
||
| // [START spanner_copy_backup_with_MR_CMEK] | ||
|
|
||
| import com.google.cloud.Timestamp; | ||
| import com.google.cloud.spanner.Spanner; | ||
| import com.google.cloud.spanner.SpannerException; | ||
| import com.google.cloud.spanner.SpannerExceptionFactory; | ||
| import com.google.cloud.spanner.SpannerOptions; | ||
| import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient; | ||
| import com.google.common.collect.ImmutableList; | ||
| import com.google.spanner.admin.database.v1.Backup; | ||
| import com.google.spanner.admin.database.v1.BackupName; | ||
| import com.google.spanner.admin.database.v1.CopyBackupEncryptionConfig; | ||
| import com.google.spanner.admin.database.v1.CopyBackupEncryptionConfig.EncryptionType; | ||
| import com.google.spanner.admin.database.v1.CopyBackupRequest; | ||
| import com.google.spanner.admin.database.v1.InstanceName; | ||
| import java.time.Instant; | ||
| import java.time.OffsetDateTime; | ||
| import java.time.ZoneId; | ||
| import java.util.concurrent.ExecutionException; | ||
| import java.util.concurrent.TimeUnit; | ||
|
|
||
| public class CopyBackupWithMultiRegionEncryptionKey { | ||
|
|
||
| static void copyBackupWithMultiRegionEncryptionKey() { | ||
| // TODO(developer): Replace these variables before running the sample. | ||
| String projectId = "my-project"; | ||
| String instanceId = "my-instance"; | ||
| String sourceBackupId = "my-backup"; | ||
| String destinationBackupId = "my-destination-backup"; | ||
| String[] kmsKeyNames = | ||
| new String[] { | ||
| "projects/" + projectId + "/locations/<location1>/keyRings/<keyRing>/cryptoKeys/<keyId>", | ||
| "projects/" + projectId + "/locations/<location2>/keyRings/<keyRing>/cryptoKeys/<keyId>", | ||
| "projects/" + projectId + "/locations/<location3>/keyRings/<keyRing>/cryptoKeys/<keyId>" | ||
| }; | ||
|
|
||
| try (Spanner spanner = | ||
| SpannerOptions.newBuilder().setProjectId(projectId).build().getService(); | ||
| DatabaseAdminClient databaseAdminClient = spanner.createDatabaseAdminClient()) { | ||
| copyBackupWithMultiRegionEncryptionKey( | ||
| databaseAdminClient, | ||
| projectId, | ||
| instanceId, | ||
| sourceBackupId, | ||
| destinationBackupId, | ||
| kmsKeyNames); | ||
| } | ||
| } | ||
|
|
||
| static void copyBackupWithMultiRegionEncryptionKey( | ||
| DatabaseAdminClient databaseAdminClient, | ||
| String projectId, | ||
| String instanceId, | ||
| String sourceBackupId, | ||
| String destinationBackupId, | ||
| String[] kmsKeyNames) { | ||
|
|
||
| Timestamp expireTime = | ||
| Timestamp.ofTimeMicroseconds( | ||
| TimeUnit.MICROSECONDS.convert( | ||
| System.currentTimeMillis() + TimeUnit.DAYS.toMillis(14), TimeUnit.MILLISECONDS)); | ||
|
|
||
| // Initiate the request which returns an OperationFuture. | ||
| System.out.println("Copying backup [" + destinationBackupId + "]..."); | ||
| CopyBackupRequest request = | ||
| CopyBackupRequest.newBuilder() | ||
| .setParent(InstanceName.of(projectId, instanceId).toString()) | ||
| .setBackupId(destinationBackupId) | ||
| .setSourceBackup(BackupName.of(projectId, instanceId, sourceBackupId).toString()) | ||
| .setExpireTime(expireTime.toProto()) | ||
| .setEncryptionConfig( | ||
| CopyBackupEncryptionConfig.newBuilder() | ||
| .setEncryptionType(EncryptionType.CUSTOMER_MANAGED_ENCRYPTION) | ||
| .addAllKmsKeyNames(ImmutableList.copyOf(kmsKeyNames)) | ||
| .build()) | ||
| .build(); | ||
| Backup destinationBackup; | ||
| try { | ||
| // Creates a copy of an existing backup. | ||
| // Wait for the backup operation to complete. | ||
| destinationBackup = databaseAdminClient.copyBackupAsync(request).get(); | ||
| System.out.println("Copied backup [" + destinationBackup.getName() + "]"); | ||
| } catch (ExecutionException e) { | ||
| throw (SpannerException) e.getCause(); | ||
| } catch (InterruptedException e) { | ||
| throw SpannerExceptionFactory.propagateInterrupt(e); | ||
| } | ||
| // Load the metadata of the new backup from the server. | ||
| destinationBackup = databaseAdminClient.getBackup(destinationBackup.getName()); | ||
| System.out.println( | ||
| String.format( | ||
| "Backup %s of size %d bytes was copied at %s for version of database at %s", | ||
| destinationBackup.getName(), | ||
| destinationBackup.getSizeBytes(), | ||
| OffsetDateTime.ofInstant( | ||
| Instant.ofEpochSecond( | ||
| destinationBackup.getCreateTime().getSeconds(), | ||
| destinationBackup.getCreateTime().getNanos()), | ||
| ZoneId.systemDefault()), | ||
| OffsetDateTime.ofInstant( | ||
| Instant.ofEpochSecond( | ||
| destinationBackup.getVersionTime().getSeconds(), | ||
| destinationBackup.getVersionTime().getNanos()), | ||
| ZoneId.systemDefault()))); | ||
| } | ||
| } | ||
| // [END spanner_copy_backup_with_MR_CMEK] |
123 changes: 123 additions & 0 deletions
123
.../snippets/src/main/java/com/example/spanner/CreateBackupWithMultiRegionEncryptionKey.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| /* | ||
| * Copyright 2024 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.example.spanner; | ||
|
|
||
| // [START spanner_create_backup_with_MR_CMEK] | ||
|
|
||
| import com.google.cloud.spanner.Spanner; | ||
| import com.google.cloud.spanner.SpannerExceptionFactory; | ||
| import com.google.cloud.spanner.SpannerOptions; | ||
| import com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient; | ||
| import com.google.common.collect.ImmutableList; | ||
| import com.google.protobuf.Timestamp; | ||
| import com.google.spanner.admin.database.v1.Backup; | ||
| import com.google.spanner.admin.database.v1.BackupName; | ||
| import com.google.spanner.admin.database.v1.CreateBackupEncryptionConfig; | ||
| import com.google.spanner.admin.database.v1.CreateBackupEncryptionConfig.EncryptionType; | ||
| import com.google.spanner.admin.database.v1.CreateBackupRequest; | ||
| import com.google.spanner.admin.database.v1.DatabaseName; | ||
| import com.google.spanner.admin.database.v1.InstanceName; | ||
| import java.util.concurrent.ExecutionException; | ||
| import java.util.concurrent.TimeUnit; | ||
| import java.util.concurrent.TimeoutException; | ||
| import org.threeten.bp.LocalDateTime; | ||
| import org.threeten.bp.OffsetDateTime; | ||
|
|
||
| public class CreateBackupWithMultiRegionEncryptionKey { | ||
|
|
||
| static void createBackupWithMultiRegionEncryptionKey() { | ||
| // TODO(developer): Replace these variables before running the sample. | ||
| String projectId = "my-project"; | ||
| String instanceId = "my-instance"; | ||
| String databaseId = "my-database"; | ||
| String backupId = "my-backup"; | ||
| String[] kmsKeyNames = | ||
| new String[] { | ||
| "projects/" + projectId + "/locations/<location1>/keyRings/<keyRing>/cryptoKeys/<keyId>", | ||
| "projects/" + projectId + "/locations/<location2>/keyRings/<keyRing>/cryptoKeys/<keyId>", | ||
| "projects/" + projectId + "/locations/<location3>/keyRings/<keyRing>/cryptoKeys/<keyId>" | ||
| }; | ||
|
|
||
| try (Spanner spanner = | ||
| SpannerOptions.newBuilder().setProjectId(projectId).build().getService(); | ||
| DatabaseAdminClient adminClient = spanner.createDatabaseAdminClient()) { | ||
| createBackupWithMultiRegionEncryptionKey( | ||
| adminClient, projectId, instanceId, databaseId, backupId, kmsKeyNames); | ||
| } | ||
| } | ||
|
|
||
| static Void createBackupWithMultiRegionEncryptionKey( | ||
| DatabaseAdminClient adminClient, | ||
| String projectId, | ||
| String instanceId, | ||
| String databaseId, | ||
| String backupId, | ||
| String[] kmsKeyNames) { | ||
| // Set expire time to 14 days from now. | ||
| final Timestamp expireTime = | ||
| Timestamp.newBuilder() | ||
| .setSeconds( | ||
| TimeUnit.MILLISECONDS.toSeconds( | ||
| (System.currentTimeMillis() + TimeUnit.DAYS.toMillis(14)))) | ||
| .build(); | ||
| final BackupName backupName = BackupName.of(projectId, instanceId, backupId); | ||
| Backup backup = | ||
| Backup.newBuilder() | ||
| .setName(backupName.toString()) | ||
| .setDatabase(DatabaseName.of(projectId, instanceId, databaseId).toString()) | ||
| .setExpireTime(expireTime) | ||
| .build(); | ||
|
|
||
| final CreateBackupRequest request = | ||
| CreateBackupRequest.newBuilder() | ||
| .setParent(InstanceName.of(projectId, instanceId).toString()) | ||
| .setBackupId(backupId) | ||
| .setBackup(backup) | ||
| .setEncryptionConfig( | ||
| CreateBackupEncryptionConfig.newBuilder() | ||
| .setEncryptionType(EncryptionType.CUSTOMER_MANAGED_ENCRYPTION) | ||
| .addAllKmsKeyNames(ImmutableList.copyOf(kmsKeyNames)) | ||
| .build()) | ||
| .build(); | ||
| try { | ||
| System.out.println("Waiting for operation to complete..."); | ||
| backup = adminClient.createBackupAsync(request).get(1200, TimeUnit.SECONDS); | ||
| } catch (ExecutionException e) { | ||
| // If the operation failed during execution, expose the cause. | ||
| throw SpannerExceptionFactory.asSpannerException(e.getCause()); | ||
| } catch (InterruptedException e) { | ||
| // Throw when a thread is waiting, sleeping, or otherwise occupied, | ||
| // and the thread is interrupted, either before or during the activity. | ||
| throw SpannerExceptionFactory.propagateInterrupt(e); | ||
| } catch (TimeoutException e) { | ||
| // If the operation timed out propagates the timeout | ||
| throw SpannerExceptionFactory.propagateTimeout(e); | ||
| } | ||
| System.out.printf( | ||
| "Backup %s of size %d bytes was created at %s using encryption keys %s%n", | ||
| backup.getName(), | ||
| backup.getSizeBytes(), | ||
| LocalDateTime.ofEpochSecond( | ||
| backup.getCreateTime().getSeconds(), | ||
| backup.getCreateTime().getNanos(), | ||
| OffsetDateTime.now().getOffset()), | ||
| ImmutableList.copyOf(kmsKeyNames)); | ||
|
|
||
| return null; | ||
| } | ||
| } | ||
| // [END spanner_create_backup_with_MR_CMEK] |
Oops, something went wrong.