feat: make CopyBackup sample runnable

Author: olavloite

google-cloud-spanner/src/main/java/com/google/cloud/spanner/BackupInfo.java

@@ -82,8 +82,6 @@ public abstract static class Builder {
      */
     public abstract Builder setDatabase(DatabaseId database);
 
-    public abstract Builder setSourceBackup(String sourceBackup);
-
     /** Builds the backup from this builder. */
     public abstract Backup build();
   }
@@ -97,7 +95,6 @@ abstract static class BuilderImpl extends Builder {
     private long size;
     private BackupEncryptionConfig encryptionConfig;
     private EncryptionInfo encryptionInfo;
-    private String sourceBackup;
     private com.google.spanner.admin.database.v1.Backup proto;
 
     BuilderImpl(BackupId id) {
@@ -128,12 +125,6 @@ public Builder setExpireTime(Timestamp expireTime) {
       return this;
     }
 
-    @Override
-    public Builder setSourceBackup(String sourceBackup) {
-      this.sourceBackup = Preconditions.checkNotNull(sourceBackup);
-      return this;
-    }
-
     @Override
     public Builder setVersionTime(Timestamp versionTime) {
       this.versionTime = versionTime;

google-cloud-spanner/src/main/java/com/google/cloud/spanner/DatabaseAdminClient.java

@@ -28,7 +28,6 @@
 import com.google.spanner.admin.database.v1.CreateDatabaseRequest;
 import com.google.spanner.admin.database.v1.RestoreDatabaseMetadata;
 import com.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata;
-
 import java.util.List;
 import javax.annotation.Nullable;
 
@@ -181,64 +180,68 @@ OperationFuture<Backup, CreateBackupMetadata> createBackup(
   OperationFuture<Backup, CreateBackupMetadata> createBackup(Backup backup) throws SpannerException;
 
   /**
-   * Creates a copy of backup from an existing database backup in a Cloud Spanner instance.
+   * Creates a copy of backup from an existing backup in a Cloud Spanner instance.
    *
    * <p>Example to copy a backup.
    *
    * <pre>{@code
-   * String instance                    = my_instance_id;
-   * String destinationBackupId         = my_backup_id;
-   * String sourceBackup                = source_backup;
+   * String instanceId                  = "my_instance_id";
+   * String sourceBackupId              = "source_backup_id";
+   * String destinationBackupId         = "destination_backup_id";
    * Timestamp expireTime               = Timestamp.ofTimeMicroseconds(micros);
    * OperationFuture<Backup, CopyBackupMetadata> op = dbAdminClient
    *     .copyBackup(
    *         instanceId,
-   *         sourceBackup,
+   *         sourceBackupId,
    *         destinationBackupId,
    *         expireTime);
    * Backup backup = op.get();
    * }</pre>
    *
-   * @param sourceInstanceId the id of the instance where the database to backup is located and
-   *     where the backup will be created.
-   * @param sourceBackup the source backup id.
-   * @param destinationBackupId the id of the backup which will be created. It must conform to the regular
-   *     expression [a-z][a-z0-9_\-]*[a-z0-9] and be between 2 and 60 characters in length.
-   * @param expireTime the time that the backup will automatically expire.
+   * @param instanceId the id of the instance where the source backup is located and where the new
+   *     backup will be created.
+   * @param sourceBackupId the source backup id.
+   * @param destinationBackupId the id of the backup which will be created. It must conform to the
+   *     regular expression [a-z][a-z0-9_\-]*[a-z0-9] and be between 2 and 60 characters in length.
+   * @param expireTime the time that the new backup will automatically expire.
    */
   OperationFuture<Backup, CopyBackupMetadata> copyBackup(
-          String sourceInstanceId, String sourceBackup, String destinationBackupId, Timestamp expireTime)
-          throws SpannerException;
-
+      String instanceId, String sourceBackupId, String destinationBackupId, Timestamp expireTime)
+      throws SpannerException;
 
   /**
-   * Creates a copy of backup from an existing database backup in Cloud Spanner. Any configuration options in the
-   * {@link Backup} instance will be included in the {@link
+   * Creates a copy of backup from an existing backup in Cloud Spanner. Any configuration options in
+   * the {@link Backup} instance will be included in the {@link
    * com.google.spanner.admin.database.v1.CopyBackupRequest}.
    *
-   * <p>Example to create an encrypted backup.
+   * <p>The expire time of the new backup must be set and be at least 6 hours and at most 366 days
+   * after the creation time of the existing backup that is being copied.
+   *
+   * <p>Example to create a copy of a backup.
    *
    * <pre>{@code
-   * BackupId destinationBackupId = BackupId.of("project", "instance", "backup-id");
+   * BackupId sourceBackupId = BackupId.of("source-project", "source-instance", "source-backup-id");
+   * BackupId destinationBackupId = BackupId.of("destination-project", "destination-instance", "new-backup-id");
    * Timestamp expireTime = Timestamp.ofTimeMicroseconds(expireTimeMicros);
    * EncryptionConfig encryptionConfig =
    *         EncryptionConfig.ofKey(
    *             "projects/my-project/locations/some-location/keyRings/my-keyring/cryptoKeys/my-key"));
    *
-   * Backup backupToCopy = dbAdminClient
+   * Backup destinationBackup = dbAdminClient
    *     .newBackupBuilder(destinationBackupId)
    *     .setExpireTime(expireTime)
-   *     .setVersionTime(versionTime)
    *     .setEncryptionConfig(encryptionConfig)
    *     .build();
    *
-   * OperationFuture<Backup, CopyBackupMetadata> op = dbAdminClient.copyBackUp(backupToCopy);
+   * OperationFuture<Backup, CopyBackupMetadata> op = dbAdminClient.copyBackUp(sourceBackupId, destinationBackup);
    * Backup copiedBackup = op.get();
    * }</pre>
    *
-   * @param backup the backup to be copied
+   * @param sourceBackupId the backup to be copied
+   * @param destinationBackup the new backup to create
    */
-  OperationFuture<Backup, CopyBackupMetadata> copyBackup(Backup backup) throws SpannerException;
+  OperationFuture<Backup, CopyBackupMetadata> copyBackup(
+      BackupId sourceBackupId, Backup destinationBackup) throws SpannerException;
 
   /**
    * Restore a database from a backup. The database that is restored will be created and may not

google-cloud-spanner/src/main/java/com/google/cloud/spanner/DatabaseAdminClientImpl.java

@@ -37,7 +37,6 @@
 import com.google.spanner.admin.database.v1.CreateDatabaseMetadata;
 import com.google.spanner.admin.database.v1.RestoreDatabaseMetadata;
 import com.google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata;
-
 import java.util.List;
 import java.util.UUID;
 import javax.annotation.Nullable;
@@ -169,46 +168,45 @@ public OperationFuture<Backup, CreateBackupMetadata> createBackup(Backup backupI
 
   @Override
   public OperationFuture<Backup, CopyBackupMetadata> copyBackup(
-          String instanceId, String sourceBackUp, String destinationBackupId, Timestamp expireTime)
-          throws SpannerException {
-    final Backup backupInfo =
-            newBackupBuilder(BackupId.of(projectId, instanceId, destinationBackupId))
-                    .setExpireTime(expireTime)
-                    .setSourceBackup(sourceBackUp)
-                    .build();
+      String instanceId, String sourceBackupId, String destinationBackupId, Timestamp expireTime)
+      throws SpannerException {
+    final Backup destinationBackup =
+        newBackupBuilder(BackupId.of(projectId, instanceId, destinationBackupId))
+            .setExpireTime(expireTime)
+            .build();
 
-    return copyBackup(backupInfo);
+    return copyBackup(BackupId.of(projectId, instanceId, sourceBackupId), destinationBackup);
   }
 
   @Override
-  public OperationFuture<Backup, CopyBackupMetadata> copyBackup(Backup backupInfo)
-          throws SpannerException {
-    Preconditions.checkArgument(
-            backupInfo.getId() != null, "Cannot create a backup without a source backup");
+  public OperationFuture<Backup, CopyBackupMetadata> copyBackup(
+      BackupId sourceBackupId, Backup destinationBackup) throws SpannerException {
+    Preconditions.checkNotNull(sourceBackupId);
+    Preconditions.checkNotNull(destinationBackup);
 
     final OperationFuture<com.google.spanner.admin.database.v1.Backup, CopyBackupMetadata>
-            rawOperationFuture = rpc.copyBackUp(backupInfo);
+        rawOperationFuture = rpc.copyBackUp(sourceBackupId, destinationBackup);
 
     return new OperationFutureImpl<>(
-            rawOperationFuture.getPollingFuture(),
-            rawOperationFuture.getInitialFuture(),
-            snapshot -> {
-              com.google.spanner.admin.database.v1.Backup proto =
-                      ProtoOperationTransformers.ResponseTransformer.create(
-                                      com.google.spanner.admin.database.v1.Backup.class)
-                              .apply(snapshot);
-              return Backup.fromProto(
-                      com.google.spanner.admin.database.v1.Backup.newBuilder(proto)
-                              .setName(proto.getName())
-                              .setExpireTime(proto.getExpireTime())
-                              .setEncryptionInfo(proto.getEncryptionInfo())
-                              .build(),
-                      DatabaseAdminClientImpl.this);
-            },
-            ProtoOperationTransformers.MetadataTransformer.create(CopyBackupMetadata.class),
-            e -> {
-              throw SpannerExceptionFactory.newSpannerException(e);
-            });
+        rawOperationFuture.getPollingFuture(),
+        rawOperationFuture.getInitialFuture(),
+        snapshot -> {
+          com.google.spanner.admin.database.v1.Backup proto =
+              ProtoOperationTransformers.ResponseTransformer.create(
+                      com.google.spanner.admin.database.v1.Backup.class)
+                  .apply(snapshot);
+          return Backup.fromProto(
+              com.google.spanner.admin.database.v1.Backup.newBuilder(proto)
+                  .setName(proto.getName())
+                  .setExpireTime(proto.getExpireTime())
+                  .setEncryptionInfo(proto.getEncryptionInfo())
+                  .build(),
+              DatabaseAdminClientImpl.this);
+        },
+        ProtoOperationTransformers.MetadataTransformer.create(CopyBackupMetadata.class),
+        e -> {
+          throw SpannerExceptionFactory.newSpannerException(e);
+        });
   }
 
   @Override

google-cloud-spanner/src/main/java/com/google/cloud/spanner/encryption/EncryptionConfigProtoMapper.java

@@ -53,21 +53,21 @@ public static CreateBackupEncryptionConfig createBackupEncryptionConfig(
 
   /** Returns an encryption config to be used for a copy backup. */
   public static CopyBackupEncryptionConfig copyBackupEncryptionConfig(
-          BackupEncryptionConfig config) {
+      BackupEncryptionConfig config) {
     if (config instanceof CustomerManagedEncryption) {
       return CopyBackupEncryptionConfig.newBuilder()
-              .setEncryptionType(
-                      CopyBackupEncryptionConfig.EncryptionType.CUSTOMER_MANAGED_ENCRYPTION)
-              .setKmsKeyName(((CustomerManagedEncryption) config).getKmsKeyName())
-              .build();
+          .setEncryptionType(CopyBackupEncryptionConfig.EncryptionType.CUSTOMER_MANAGED_ENCRYPTION)
+          .setKmsKeyName(((CustomerManagedEncryption) config).getKmsKeyName())
+          .build();
     } else if (config instanceof GoogleDefaultEncryption) {
       return CopyBackupEncryptionConfig.newBuilder()
-              .setEncryptionType(CopyBackupEncryptionConfig.EncryptionType.GOOGLE_DEFAULT_ENCRYPTION)
-              .build();
+          .setEncryptionType(CopyBackupEncryptionConfig.EncryptionType.GOOGLE_DEFAULT_ENCRYPTION)
+          .build();
     } else if (config instanceof UseBackupEncryption) {
       return CopyBackupEncryptionConfig.newBuilder()
-              .setEncryptionType(CopyBackupEncryptionConfig.EncryptionType.USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION)
-              .build();
+          .setEncryptionType(
+              CopyBackupEncryptionConfig.EncryptionType.USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION)
+          .build();
     } else {
       throw new IllegalArgumentException("Unknown backup encryption configuration " + config);
     }

google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/GapicSpannerRpc.java

@@ -60,6 +60,7 @@
 import com.google.cloud.grpc.GcpManagedChannelOptions.GcpMetricsOptions;
 import com.google.cloud.grpc.GrpcTransportOptions;
 import com.google.cloud.spanner.AdminRequestsPerMinuteExceededException;
+import com.google.cloud.spanner.BackupId;
 import com.google.cloud.spanner.ErrorCode;
 import com.google.cloud.spanner.Restore;
 import com.google.cloud.spanner.SpannerException;
@@ -1266,69 +1267,63 @@ public OperationFuture<Backup, CreateBackupMetadata> createBackup(
         NanoClock.getDefaultClock());
   }
 
-
   @Override
   public OperationFuture<Backup, CopyBackupMetadata> copyBackUp(
-          final com.google.cloud.spanner.Backup backupInfo) throws SpannerException {
-    final String instanceName = backupInfo.getInstanceId().getName();
-    final String databaseName = backupInfo.getDatabase().getName();
-    final String backupId = backupInfo.getId().getBackup();
-    final Backup.Builder backupBuilder =
-            com.google.spanner.admin.database.v1.Backup.newBuilder()
-                    .setDatabase(databaseName)
-                    .setExpireTime(backupInfo.getExpireTime().toProto());
-    if (backupInfo.getVersionTime() != null) {
-      backupBuilder.setVersionTime(backupInfo.getVersionTime().toProto());
-    }
+      BackupId sourceBackupId, final com.google.cloud.spanner.Backup destinationBackup)
+      throws SpannerException {
+    Preconditions.checkNotNull(sourceBackupId);
+    Preconditions.checkNotNull(destinationBackup);
+    final String instanceName = destinationBackup.getInstanceId().getName();
+    final String backupId = destinationBackup.getId().getBackup();
 
     final CopyBackupRequest.Builder requestBuilder =
-            CopyBackupRequest.newBuilder()
-                    .setParent(instanceName)
-                    .setBackupId(backupId)
-                    .setSourceBackup(backupId)
-                    .setExpireTime(backupInfo.getExpireTime().toProto()) ;
+        CopyBackupRequest.newBuilder()
+            .setParent(instanceName)
+            .setBackupId(backupId)
+            .setSourceBackup(sourceBackupId.getName())
+            .setExpireTime(destinationBackup.getExpireTime().toProto());
 
-    if (backupInfo.getEncryptionConfig() != null) {
+    if (destinationBackup.getEncryptionConfig() != null) {
       requestBuilder.setEncryptionConfig(
-              EncryptionConfigProtoMapper.copyBackupEncryptionConfig(
-                      backupInfo.getEncryptionConfig()));
+          EncryptionConfigProtoMapper.copyBackupEncryptionConfig(
+              destinationBackup.getEncryptionConfig()));
     }
     final CopyBackupRequest request = requestBuilder.build();
     final OperationFutureCallable<CopyBackupRequest, Backup, CopyBackupMetadata> callable =
-            new OperationFutureCallable<>(
-                    databaseAdminStub.copyBackupOperationCallable(),
-                    request,
-                    //calling copy backup method of dbClientImpl
-                    DatabaseAdminGrpc.getCopyBackupMethod(),
+        new OperationFutureCallable<>(
+            databaseAdminStub.copyBackupOperationCallable(),
+            request,
+            // calling copy backup method of dbClientImpl
+            DatabaseAdminGrpc.getCopyBackupMethod(),
+            instanceName,
+            nextPageToken ->
+                listBackupOperations(
                     instanceName,
-                    nextPageToken ->
-                            listBackupOperations(
-                                    instanceName,
-                                    0,
-                                    String.format(
-                                            "(metadata.@type:type.googleapis.com/%s) AND (metadata.name:%s)",
-                                            CopyBackupMetadata.getDescriptor().getFullName(),
-                                            String.format("%s/backups/%s", instanceName, backupId)),
-                                    nextPageToken),
-                    input -> {
-                      try {
-                        return input
-                                .getMetadata()
-                                .unpack(CopyBackupMetadata.class)
-                                .getProgress()
-                                .getStartTime();
-                      } catch (InvalidProtocolBufferException e) {
-                        return null;
-                      }
-                    });
+                    0,
+                    String.format(
+                        "(metadata.@type:type.googleapis.com/%s) AND (metadata.name:%s)",
+                        CopyBackupMetadata.getDescriptor().getFullName(),
+                        String.format("%s/backups/%s", instanceName, backupId)),
+                    nextPageToken),
+            input -> {
+              try {
+                return input
+                    .getMetadata()
+                    .unpack(CopyBackupMetadata.class)
+                    .getProgress()
+                    .getStartTime();
+              } catch (InvalidProtocolBufferException e) {
+                return null;
+              }
+            });
     return RetryHelper.runWithRetries(
-            callable,
-            databaseAdminStubSettings
-                    .copyBackupOperationSettings()
-                    .getInitialCallSettings()
-                    .getRetrySettings(),
-            new OperationFutureRetryAlgorithm<>(),
-            NanoClock.getDefaultClock());
+        callable,
+        databaseAdminStubSettings
+            .copyBackupOperationSettings()
+            .getInitialCallSettings()
+            .getRetrySettings(),
+        new OperationFutureRetryAlgorithm<>(),
+        NanoClock.getDefaultClock());
   }
 
   @Override