Skip to content

Replace LocalFilesStorageResourceProvider.FromPath with FromFile and Directory #39053

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
amnguye merged 3 commits into from
Oct 2, 2023
Merged

Replace LocalFilesStorageResourceProvider.FromPath with FromFile and Directory #39053

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
705962e
Replace LocalFilesStorageResourceProvider.FromPath with FromFile and …
amnguye Oct 2, 2023
bc704a3
Export API
amnguye Oct 2, 2023
4f97d83
Update snippets
amnguye Oct 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions sdk/storage/Azure.Storage.DataMovement.Blobs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ Upload a block blob.

```C# Snippet:SimpleBlobUpload
DataTransfer dataTransfer = await transferManager.StartTransferAsync(
sourceResource: files.FromPath(sourceLocalPath),
sourceResource: files.FromFile(sourceLocalPath),
destinationResource: blobs.FromClient(destinationBlob));
await dataTransfer.WaitForCompletionAsync();
```
Expand All @@ -200,7 +200,7 @@ Upload a directory as a specific blob type.

```C# Snippet:SimpleDirectoryUpload
DataTransfer dataTransfer = await transferManager.StartTransferAsync(
sourceResource: files.FromPath(sourcePath),
sourceResource: files.FromDirectory(sourcePath),
destinationResource: blobs.FromClient(
blobContainerClient,
new BlobStorageResourceContainerOptions()
Expand All @@ -224,7 +224,7 @@ BlobsStorageResourceProvider blobs = new();
LocalFilesStorageResourceProvider files = new();
DataTransfer dataTransfer = await transferManager.StartTransferAsync(
sourceResource: blobs.FromClient(sourceBlobClient),
destinationResource: files.FromPath(downloadPath));
destinationResource: files.FromFile(downloadPath));
await dataTransfer.WaitForCompletionAsync();
```

Expand All @@ -238,7 +238,7 @@ DataTransfer dataTransfer = await transferManager.StartTransferAsync(
{
BlobDirectoryPrefix = optionalSourcePrefix
}),
destinationResource: files.FromPath(downloadPath));
destinationResource: files.FromDirectory(downloadPath));
await dataTransfer.WaitForCompletionAsync();
```

Expand Down
32 changes: 16 additions & 16 deletions sdk/storage/Azure.Storage.DataMovement.Blobs/samples/Sample01b_HelloWorldAsync.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public async Task ResourceConstructionDemonstration()

// Get a reference to a source local file
LocalFilesStorageResourceProvider files = new();
StorageResource sourceResource = files.FromPath(sourceLocalPath);
StorageResource sourceResource = files.FromFile(sourceLocalPath);

// Get a reference to a destination blobs
BlockBlobClient blockBlobClient = blobContainerClient.GetBlockBlobClient("sample-blob-block");
Expand Down Expand Up @@ -133,7 +133,7 @@ public async Task UploadSingle_ConnectionStringAsync()
// Create simple transfer single blob upload job
#region Snippet:SimpleBlobUpload
DataTransfer dataTransfer = await transferManager.StartTransferAsync(
sourceResource: files.FromPath(sourceLocalPath),
sourceResource: files.FromFile(sourceLocalPath),
destinationResource: blobs.FromClient(destinationBlob));
await dataTransfer.WaitForCompletionAsync();
#endregion
Expand Down Expand Up @@ -206,19 +206,19 @@ public async Task DownloadSingle_SharedKeyAuthAsync()
LocalFilesStorageResourceProvider files = new();
DataTransfer dataTransfer = await transferManager.StartTransferAsync(
sourceResource: blobs.FromClient(sourceBlobClient),
destinationResource: files.FromPath(downloadPath));
destinationResource: files.FromFile(downloadPath));
await dataTransfer.WaitForCompletionAsync();
#endregion

StorageResource sourceResource2 = blobs.FromClient(sourceBlobClient);
StorageResource destinationResource2 = files.FromPath(downloadPath2);
StorageResource destinationResource2 = files.FromFile(downloadPath2);

await transferManager.StartTransferAsync(
sourceResource: blobs.FromClient(sourceBlobClient, new BlockBlobStorageResourceOptions()
{
DestinationConditions = new BlobRequestConditions(){ LeaseId = "xyz" }
}),
destinationResource: files.FromPath(downloadPath2));
destinationResource: files.FromFile(downloadPath2));
}
finally
{
Expand Down Expand Up @@ -287,7 +287,7 @@ public async Task UploadDirectory_SasAsync()
BlobsStorageResourceProvider blobs = new();
LocalFilesStorageResourceProvider files = new();
// Get a storage resource reference to a local directory
StorageResource localDirectory = files.FromPath(sourcePath);
StorageResource localDirectory = files.FromDirectory(sourcePath);
// Get a storage resource to a destination blob directory
StorageResource directoryDestination = blobs.FromClient(
blobContainerClient,
Expand All @@ -306,7 +306,7 @@ public async Task UploadDirectory_SasAsync()
string optionalDestinationPrefix = "sample-directory2";
#region Snippet:SimpleDirectoryUpload
DataTransfer dataTransfer = await transferManager.StartTransferAsync(
sourceResource: files.FromPath(sourcePath),
sourceResource: files.FromDirectory(sourcePath),
destinationResource: blobs.FromClient(
blobContainerClient,
new BlobStorageResourceContainerOptions()
Expand Down Expand Up @@ -403,7 +403,7 @@ public async Task UploadDirectory_CompletedEventHandler()

// Create simple transfer directory upload job which uploads the directory and the contents of that directory
DataTransfer uploadDirectoryJobId = await transferManager.StartTransferAsync(
files.FromPath(sourcePath),
files.FromDirectory(sourcePath),
blobs.FromClient(
container,
new BlobStorageResourceContainerOptions() { BlobDirectoryPrefix = "sample-blob-directory" }));
Expand Down Expand Up @@ -508,7 +508,7 @@ public async Task UploadDirectory_EventHandler_SasAsync()

// Create simple transfer directory upload job which uploads the directory and the contents of that directory
DataTransfer uploadDirectoryJobId = await transferManager.StartTransferAsync(
files.FromPath(sourcePath),
files.FromDirectory(sourcePath),
blobs.FromClient(
container,
new BlobStorageResourceContainerOptions() { BlobDirectoryPrefix = "sample-blob-directory" }));
Expand Down Expand Up @@ -569,8 +569,8 @@ public async Task DownloadDirectory_EventHandler_ActiveDirectoryAuthAsync()
new BlobStorageResourceContainerOptions() { BlobDirectoryPrefix = "sample-blob-directory" });
StorageResource sourceDirectory2 = blobs.FromClient(blobContainerClient,
new BlobStorageResourceContainerOptions() { BlobDirectoryPrefix = "sample-blob-directory2" });
StorageResource destinationDirectory = files.FromPath(downloadPath);
StorageResource destinationDirectory2 = files.FromPath(downloadPath2);
StorageResource destinationDirectory = files.FromDirectory(downloadPath);
StorageResource destinationDirectory2 = files.FromDirectory(downloadPath2);

// Upload a couple of blobs so we have something to list
await blobContainerClient.UploadBlobAsync("first", File.OpenRead(CreateTempFile()));
Expand Down Expand Up @@ -605,7 +605,7 @@ await transferManager.StartTransferAsync(
{
BlobDirectoryPrefix = optionalSourcePrefix
}),
destinationResource: files.FromPath(downloadPath));
destinationResource: files.FromDirectory(downloadPath));
await dataTransfer.WaitForCompletionAsync();
#endregion
}
Expand Down Expand Up @@ -733,8 +733,8 @@ public async Task CopyDirectory()
new BlobStorageResourceContainerOptions() { BlobDirectoryPrefix = sourceDirectoryName2 });

// Create destination paths
StorageResource destinationDirectory1 = files.FromPath(downloadPath);
StorageResource destinationDirectory2 = files.FromPath(downloadPath2);
StorageResource destinationDirectory1 = files.FromDirectory(downloadPath);
StorageResource destinationDirectory2 = files.FromDirectory(downloadPath2);

// Upload a couple of blobs so we have something to list
await container.UploadBlobAsync($"{sourceDirectoryName}/fourth", File.OpenRead(originalPath));
Expand Down Expand Up @@ -811,7 +811,7 @@ public async Task PauseAndResumeAsync_ManagerId()
LocalFilesStorageResourceProvider files = new();
// Create source and destination resource
StorageResource sourceResource = blobs.FromClient(sourceBlob);
StorageResource destinationResource = files.FromPath(downloadPath);
StorageResource destinationResource = files.FromFile(downloadPath);

// Create simple transfer single blob download job
DataTransfer dataTransfer = await transferManager.StartTransferAsync(
Expand Down Expand Up @@ -863,7 +863,7 @@ public async Task PauseAndResumeAsync_DataTransferPause()

// Create source and destination resource
StorageResource sourceResource = blobs.FromClient(sourceBlob);
StorageResource destinationResource = files.FromPath(downloadPath);
StorageResource destinationResource = files.FromFile(downloadPath);

// Create simple transfer single blob download job
DataTransfer dataTransfer = await transferManager.StartTransferAsync(
Expand Down
4 changes: 2 additions & 2 deletions sdk/storage/Azure.Storage.DataMovement.Blobs/src/BlobContainerClientExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ public static Task<DataTransfer> StartUploadDirectoryAsync(
/// <returns>A <see cref="DataTransfer"/> instance which can be used track progress and wait for completion with <see cref="DataTransfer.WaitForCompletionAsync"/>.</returns>
public static async Task<DataTransfer> StartUploadDirectoryAsync(this BlobContainerClient client, string localDirectoryPath, BlobContainerClientTransferOptions options)
{
StorageResource localDirectory = s_filesProvider.Value.FromPath(localDirectoryPath);
StorageResource localDirectory = s_filesProvider.Value.FromDirectory(localDirectoryPath);
StorageResource blobDirectory = s_blobsProvider.Value.FromClient(client, options?.BlobContainerOptions);

return await s_defaultTransferManager.Value.StartTransferAsync(localDirectory, blobDirectory, options?.TransferOptions).ConfigureAwait(false);
Expand Down Expand Up @@ -86,7 +86,7 @@ public static Task<DataTransfer> StartDownloadToDirectoryAsync(
/// <returns></returns>
public static async Task<DataTransfer> StartDownloadToDirectoryAsync(this BlobContainerClient client, string localDirectoryPath, BlobContainerClientTransferOptions options)
{
StorageResource localDirectory = s_filesProvider.Value.FromPath(localDirectoryPath);
StorageResource localDirectory = s_filesProvider.Value.FromDirectory(localDirectoryPath);
StorageResource blobDirectory = s_blobsProvider.Value.FromClient(client, options?.BlobContainerOptions);

return await s_defaultTransferManager.Value.StartTransferAsync(blobDirectory, localDirectory, options?.TransferOptions).ConfigureAwait(false);
Expand Down
4 changes: 2 additions & 2 deletions sdk/storage/Azure.Storage.DataMovement.Files.Shares/src/ShareDirectoryClientExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public static async Task<DataTransfer> StartUploadDirectoryAsync(
string localDirectoryPath,
ShareDirectoryClientTransferOptions options = default)
{
StorageResource localDirectory = s_localFilesProvider.Value.FromPath(localDirectoryPath);
StorageResource localDirectory = s_localFilesProvider.Value.FromDirectory(localDirectoryPath);
StorageResource shareDirectory = s_shareFilesProvider.Value.FromClient(client, options?.ShareDirectoryOptions);

return await s_defaultTransferManager.Value.StartTransferAsync(
Expand All @@ -57,7 +57,7 @@ public static async Task<DataTransfer> StartDownloadToDirectoryAsync(
string localDirectoryPath,
ShareDirectoryClientTransferOptions options = default)
{
StorageResource localDirectory = s_localFilesProvider.Value.FromPath(localDirectoryPath);
StorageResource localDirectory = s_localFilesProvider.Value.FromDirectory(localDirectoryPath);
StorageResource shareDirectory = s_shareFilesProvider.Value.FromClient(client, options?.ShareDirectoryOptions);

return await s_defaultTransferManager.Value.StartTransferAsync(
Expand Down
3 changes: 2 additions & 1 deletion sdk/storage/Azure.Storage.DataMovement/api/Azure.Storage.DataMovement.net6.0.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,8 @@ public partial class LocalFilesStorageResourceProvider : Azure.Storage.DataMovem
public LocalFilesStorageResourceProvider() { }
protected internal override string TypeId { get { throw null; } }
protected internal override System.Threading.Tasks.Task<Azure.Storage.DataMovement.StorageResource> FromDestinationAsync(Azure.Storage.DataMovement.DataTransferProperties properties, System.Threading.CancellationToken cancellationToken) { throw null; }
public Azure.Storage.DataMovement.StorageResource FromPath(string path) { throw null; }
public Azure.Storage.DataMovement.StorageResourceContainer FromDirectory(string directoryPath) { throw null; }
public Azure.Storage.DataMovement.StorageResourceItem FromFile(string filePath) { throw null; }
protected internal override System.Threading.Tasks.Task<Azure.Storage.DataMovement.StorageResource> FromSourceAsync(Azure.Storage.DataMovement.DataTransferProperties properties, System.Threading.CancellationToken cancellationToken) { throw null; }
}
public partial class ProgressHandlerOptions
Expand Down
3 changes: 2 additions & 1 deletion sdk/storage/Azure.Storage.DataMovement/api/Azure.Storage.DataMovement.netstandard2.0.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,8 @@ public partial class LocalFilesStorageResourceProvider : Azure.Storage.DataMovem
public LocalFilesStorageResourceProvider() { }
protected internal override string TypeId { get { throw null; } }
protected internal override System.Threading.Tasks.Task<Azure.Storage.DataMovement.StorageResource> FromDestinationAsync(Azure.Storage.DataMovement.DataTransferProperties properties, System.Threading.CancellationToken cancellationToken) { throw null; }
public Azure.Storage.DataMovement.StorageResource FromPath(string path) { throw null; }
public Azure.Storage.DataMovement.StorageResourceContainer FromDirectory(string directoryPath) { throw null; }
public Azure.Storage.DataMovement.StorageResourceItem FromFile(string filePath) { throw null; }
protected internal override System.Threading.Tasks.Task<Azure.Storage.DataMovement.StorageResource> FromSourceAsync(Azure.Storage.DataMovement.DataTransferProperties properties, System.Threading.CancellationToken cancellationToken) { throw null; }
}
public partial class ProgressHandlerOptions
Expand Down
29 changes: 20 additions & 9 deletions sdk/storage/Azure.Storage.DataMovement/src/LocalFilesStorageResourceProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,20 +41,31 @@ private StorageResource FromTransferProperties(DataTransferProperties properties
}

/// <summary>
/// Creates a storage resource to the file or directory at the given path.
/// Creates a storage resource to the file at the given path.
/// </summary>
/// <param name="path">
/// Path to the file or directory.
/// <param name="filePath">
/// Path to the file.
/// </param>
/// <returns>
/// Storage resource to this file or directory.
/// Storage resource to this file.
/// </returns>
public StorageResource FromPath(string path)
public StorageResourceItem FromFile(string filePath)
{
FileAttributes attributes = File.GetAttributes(path);
return attributes.HasFlag(FileAttributes.Directory)
? new LocalDirectoryStorageResourceContainer(path)
: new LocalFileStorageResource(path);
return new LocalFileStorageResource(filePath);
}

/// <summary>
/// Creates a storage resource to the directory at the given path.
/// </summary>
/// <param name="directoryPath">
/// Path to the directory.
/// </param>
/// <returns>
/// Storage resource to this directory.
/// </returns>
public StorageResourceContainer FromDirectory(string directoryPath)
{
return new LocalDirectoryStorageResourceContainer(directoryPath);
}
}
}