DataMovement StorageResource construction refactor | Part 4 (Azure#38534)

* hid implementation classes

* exportapi | updatesnippets

Author: jaschrep-msft

sdk/storage/Azure.Storage.DataMovement.Blobs/README.md

@@ -148,10 +148,11 @@ await tranfer.WaitForCompletionAsync();
 Azure.Storage.DataMovement.Blobs exposes a `StorageResource` for each type of blob (block, page, append) as well as a blob container. Storage resources are initialized with the appropriate client object from Azure.Storage.Blobs.
 
 ```C# Snippet:ResourceConstruction_Blobs
-StorageResource containerResource = new BlobStorageResourceContainer(blobContainerClient);
-StorageResource blockBlobResource = new BlockBlobStorageResource(blockBlobClient);
-StorageResource pageBlobResource = new PageBlobStorageResource(pageBlobClient);
-StorageResource appendBlobResource = new AppendBlobStorageResource(appendBlobClient);
+BlobsStorageResourceProvider blobs = new();
+StorageResource containerResource = blobs.FromClient(blobContainerClient);
+StorageResource blockBlobResource = blobs.FromClient(blockBlobClient);
+StorageResource pageBlobResource = blobs.FromClient(pageBlobClient);
+StorageResource appendBlobResource = blobs.FromClient(appendBlobClient);
 ```
 
 Blob `StorageResource` objects can be constructed with optional "options" arguments specific to the type of resource.
@@ -162,7 +163,7 @@ BlobStorageResourceContainerOptions virtualDirectoryOptions = new()
     BlobDirectoryPrefix = "blob/directory/prefix"
 };
 
-StorageResource virtualDirectoryResource = new BlobStorageResourceContainer(
+StorageResource virtualDirectoryResource = blobs.FromClient(
     blobContainerClient,
     virtualDirectoryOptions);
 ```
@@ -175,7 +176,7 @@ BlockBlobStorageResourceOptions leasedResourceOptions = new()
         LeaseId = leaseId
     }
 };
-StorageResource leasedBlockBlobResource = new BlockBlobStorageResource(
+StorageResource leasedBlockBlobResource = blobs.FromClient(
     blockBlobClient,
     leasedResourceOptions);
 ```
@@ -190,17 +191,17 @@ Upload a block blob.
 
 ```C# Snippet:SimpleBlobUpload
 DataTransfer dataTransfer = await transferManager.StartTransferAsync(
-    sourceResource: new LocalFileStorageResource(sourceLocalPath),
-    destinationResource: new BlockBlobStorageResource(destinationBlob));
+    sourceResource: files.FromPath(sourceLocalPath),
+    destinationResource: blobs.FromClient(destinationBlob));
 await dataTransfer.WaitForCompletionAsync();
 ```
 
 Upload a directory as a specific blob type.
 
 ```C# Snippet:SimpleDirectoryUpload
 DataTransfer dataTransfer = await transferManager.StartTransferAsync(
-    sourceResource: new LocalDirectoryStorageResourceContainer(sourcePath),
-    destinationResource: new BlobStorageResourceContainer(
+    sourceResource: files.FromPath(sourcePath),
+    destinationResource: blobs.FromClient(
         blobContainerClient,
         new BlobStorageResourceContainerOptions()
         {
@@ -219,23 +220,25 @@ A download takes place between a blob `StorageResource` as source and local file
 Download a block blob.
 
 ```C# Snippet:SimpleBlockBlobDownload
+BlobsStorageResourceProvider blobs = new();
+LocalFilesStorageResourceProvider files = new();
 DataTransfer dataTransfer = await transferManager.StartTransferAsync(
-    sourceResource: new BlockBlobStorageResource(sourceBlobClient),
-    destinationResource: new LocalFileStorageResource(downloadPath));
+    sourceResource: blobs.FromClient(sourceBlobClient),
+    destinationResource: files.FromPath(downloadPath));
 await dataTransfer.WaitForCompletionAsync();
 ```
 
 Download a container which may contain a mix of blob types.
 
 ```C# Snippet:SimpleDirectoryDownload_Blob
 DataTransfer dataTransfer = await transferManager.StartTransferAsync(
-    sourceResource: new BlobStorageResourceContainer(
+    sourceResource: blobs.FromClient(
         blobContainerClient,
         new BlobStorageResourceContainerOptions()
         {
             BlobDirectoryPrefix = optionalSourcePrefix
         }),
-    destinationResource: new LocalDirectoryStorageResourceContainer(downloadPath));
+    destinationResource: files.FromPath(downloadPath));
 await dataTransfer.WaitForCompletionAsync();
 ```
 
@@ -246,23 +249,25 @@ A copy takes place between two blob `StorageResource` instances. Copying between
 Copy a single blob. Note the change in blob type on this copy from block to append.
 
 ```C# Snippet:s2sCopyBlob
+BlobsStorageResourceProvider blobs = new();
+LocalFilesStorageResourceProvider files = new();
 DataTransfer dataTransfer = await transferManager.StartTransferAsync(
-    sourceResource: new BlockBlobStorageResource(sourceBlockBlobClient),
-    destinationResource: new AppendBlobStorageResource(destinationAppendBlobClient));
+    sourceResource: blobs.FromClient(sourceBlockBlobClient),
+    destinationResource: blobs.FromClient(destinationAppendBlobClient));
 await dataTransfer.WaitForCompletionAsync();
 ```
 
 Copy a blob container.
 
 ```C# Snippet:s2sCopyBlobContainer
 DataTransfer dataTransfer = await transferManager.StartTransferAsync(
-    sourceResource: new BlobStorageResourceContainer(
+    sourceResource: blobs.FromClient(
         sourceContainer,
         new BlobStorageResourceContainerOptions()
         {
             BlobDirectoryPrefix = sourceDirectoryName
         }),
-    destinationResource: new BlobStorageResourceContainer(
+    destinationResource: blobs.FromClient(
         destinationContainer,
         new BlobStorageResourceContainerOptions()
         {

sdk/storage/Azure.Storage.DataMovement.Blobs/api/Azure.Storage.DataMovement.Blobs.net6.0.cs

@@ -10,23 +10,6 @@ public static partial class BlobContainerClientExtensions
 }
 namespace Azure.Storage.DataMovement.Blobs
 {
-    public partial class AppendBlobStorageResource : Azure.Storage.DataMovement.StorageResourceItem
-    {
-        public AppendBlobStorageResource(Azure.Storage.Blobs.Specialized.AppendBlobClient blobClient, Azure.Storage.DataMovement.Blobs.AppendBlobStorageResourceOptions options = null) { }
-        protected override long? Length { get { throw null; } }
-        protected override long MaxChunkSize { get { throw null; } }
-        protected override string ResourceId { get { throw null; } }
-        protected override Azure.Storage.DataMovement.DataTransferOrder TransferType { get { throw null; } }
-        public override System.Uri Uri { get { throw null; } }
-        protected override System.Threading.Tasks.Task CompleteTransferAsync(bool overwrite, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        protected override System.Threading.Tasks.Task CopyBlockFromUriAsync(Azure.Storage.DataMovement.StorageResourceItem sourceResource, Azure.HttpRange range, bool overwrite, long completeLength, Azure.Storage.DataMovement.StorageResourceCopyFromUriOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        protected override System.Threading.Tasks.Task CopyFromStreamAsync(System.IO.Stream stream, long streamLength, bool overwrite, long completeLength, Azure.Storage.DataMovement.StorageResourceWriteToOffsetOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        protected override System.Threading.Tasks.Task CopyFromUriAsync(Azure.Storage.DataMovement.StorageResourceItem sourceResource, bool overwrite, long completeLength, Azure.Storage.DataMovement.StorageResourceCopyFromUriOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        protected override System.Threading.Tasks.Task<bool> DeleteIfExistsAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        protected override System.Threading.Tasks.Task<Azure.HttpAuthorization> GetCopyAuthorizationHeaderAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        protected override System.Threading.Tasks.Task<Azure.Storage.DataMovement.StorageResourceProperties> GetPropertiesAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        protected override System.Threading.Tasks.Task<Azure.Storage.DataMovement.StorageResourceReadStreamResult> ReadStreamAsync(long position = (long)0, long? length = default(long?), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-    }
     public partial class AppendBlobStorageResourceOptions : Azure.Storage.DataMovement.Blobs.BlobStorageResourceOptions
     {
         public AppendBlobStorageResourceOptions() { }
@@ -61,13 +44,6 @@ public BlobsStorageResourceProvider(Azure.Storage.StorageSharedKeyCredential cre
         public delegate Azure.Storage.StorageSharedKeyCredential GetStorageSharedKeyCredential(string uri, bool readOnly);
         public delegate Azure.Core.TokenCredential GetTokenCredential(string uri, bool readOnly);
     }
-    public partial class BlobStorageResourceContainer : Azure.Storage.DataMovement.StorageResourceContainer
-    {
-        public BlobStorageResourceContainer(Azure.Storage.Blobs.BlobContainerClient blobContainerClient, Azure.Storage.DataMovement.Blobs.BlobStorageResourceContainerOptions options = null) { }
-        public override System.Uri Uri { get { throw null; } }
-        protected override Azure.Storage.DataMovement.StorageResourceItem GetStorageResourceReference(string path) { throw null; }
-        protected override System.Collections.Generic.IAsyncEnumerable<Azure.Storage.DataMovement.StorageResource> GetStorageResourcesAsync([System.Runtime.CompilerServices.EnumeratorCancellationAttribute] System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-    }
     public partial class BlobStorageResourceContainerOptions
     {
         public BlobStorageResourceContainerOptions() { }
@@ -87,46 +63,12 @@ public BlobStorageResourceOptions() { }
         public System.Collections.Generic.IDictionary<string, string> Tags { get { throw null; } set { } }
         public Azure.Storage.UploadTransferValidationOptions UploadTransferValidationOptions { get { throw null; } set { } }
     }
-    public partial class BlockBlobStorageResource : Azure.Storage.DataMovement.StorageResourceItem
-    {
-        public BlockBlobStorageResource(Azure.Storage.Blobs.Specialized.BlockBlobClient blobClient, Azure.Storage.DataMovement.Blobs.BlockBlobStorageResourceOptions options = null) { }
-        protected override long? Length { get { throw null; } }
-        protected override long MaxChunkSize { get { throw null; } }
-        protected override string ResourceId { get { throw null; } }
-        protected override Azure.Storage.DataMovement.DataTransferOrder TransferType { get { throw null; } }
-        public override System.Uri Uri { get { throw null; } }
-        protected override System.Threading.Tasks.Task CompleteTransferAsync(bool overwrite, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        protected override System.Threading.Tasks.Task CopyBlockFromUriAsync(Azure.Storage.DataMovement.StorageResourceItem sourceResource, Azure.HttpRange range, bool overwrite, long completeLength, Azure.Storage.DataMovement.StorageResourceCopyFromUriOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        protected override System.Threading.Tasks.Task CopyFromStreamAsync(System.IO.Stream stream, long streamLength, bool overwrite, long completeLength, Azure.Storage.DataMovement.StorageResourceWriteToOffsetOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        protected override System.Threading.Tasks.Task CopyFromUriAsync(Azure.Storage.DataMovement.StorageResourceItem sourceResource, bool overwrite, long completeLength, Azure.Storage.DataMovement.StorageResourceCopyFromUriOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        protected override System.Threading.Tasks.Task<bool> DeleteIfExistsAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        protected override System.Threading.Tasks.Task<Azure.HttpAuthorization> GetCopyAuthorizationHeaderAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        protected override System.Threading.Tasks.Task<Azure.Storage.DataMovement.StorageResourceProperties> GetPropertiesAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        protected override System.Threading.Tasks.Task<Azure.Storage.DataMovement.StorageResourceReadStreamResult> ReadStreamAsync(long position = (long)0, long? length = default(long?), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-    }
     public partial class BlockBlobStorageResourceOptions : Azure.Storage.DataMovement.Blobs.BlobStorageResourceOptions
     {
         public BlockBlobStorageResourceOptions() { }
         public Azure.Storage.Blobs.Models.BlobRequestConditions DestinationConditions { get { throw null; } set { } }
         public Azure.Storage.Blobs.Models.BlobRequestConditions SourceConditions { get { throw null; } set { } }
     }
-    public partial class PageBlobStorageResource : Azure.Storage.DataMovement.StorageResourceItem
-    {
-        public PageBlobStorageResource(Azure.Storage.Blobs.Specialized.PageBlobClient blobClient, Azure.Storage.DataMovement.Blobs.PageBlobStorageResourceOptions options = null) { }
-        protected override long? Length { get { throw null; } }
-        protected override long MaxChunkSize { get { throw null; } }
-        protected override string ResourceId { get { throw null; } }
-        protected override Azure.Storage.DataMovement.DataTransferOrder TransferType { get { throw null; } }
-        public override System.Uri Uri { get { throw null; } }
-        protected override System.Threading.Tasks.Task CompleteTransferAsync(bool overwrite, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        protected override System.Threading.Tasks.Task CopyBlockFromUriAsync(Azure.Storage.DataMovement.StorageResourceItem sourceResource, Azure.HttpRange range, bool overwrite, long completeLength, Azure.Storage.DataMovement.StorageResourceCopyFromUriOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        protected override System.Threading.Tasks.Task CopyFromStreamAsync(System.IO.Stream stream, long streamLength, bool overwrite, long completeLength, Azure.Storage.DataMovement.StorageResourceWriteToOffsetOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        protected override System.Threading.Tasks.Task CopyFromUriAsync(Azure.Storage.DataMovement.StorageResourceItem sourceResource, bool overwrite, long completeLength, Azure.Storage.DataMovement.StorageResourceCopyFromUriOptions options = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        protected override System.Threading.Tasks.Task<bool> DeleteIfExistsAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        protected override System.Threading.Tasks.Task<Azure.HttpAuthorization> GetCopyAuthorizationHeaderAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        protected override System.Threading.Tasks.Task<Azure.Storage.DataMovement.StorageResourceProperties> GetPropertiesAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-        protected override System.Threading.Tasks.Task<Azure.Storage.DataMovement.StorageResourceReadStreamResult> ReadStreamAsync(long position = (long)0, long? length = default(long?), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
-    }
     public partial class PageBlobStorageResourceOptions : Azure.Storage.DataMovement.Blobs.BlobStorageResourceOptions
     {
         public PageBlobStorageResourceOptions() { }