C# Class Amazon.Glacier.Transfer.ArchiveTransferManager

Provides a high level API for managing transfers to and from Amazon Glacier. This removes complexities such as breaking files into parts and computing check sums.

Inheritance: IDisposable

Mostrar archivo Open project: aws/aws-sdk-net Class Usage Examples

Private Properties

Property	Type	Description

Public Methods

Method	Description
ArchiveTransferManager ( AWSCredentials credentials, RegionEndpoint region ) : System	Constructs an ArchiveTransferManager object using the specified AWS credentials and Amazon Glacier region endpoint.
ArchiveTransferManager ( IAmazonGlacier glacier ) : System	Constructs an ArchiveTransferManager object using an existing Amazon Glacier client.
ArchiveTransferManager ( RegionEndpoint region ) : System	Constructs an ArchiveTransferManager object for the specified Amazon Glacier region endpoint using the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. `<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>`
ArchiveTransferManager ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System	Constructs an ArchiveTransferManager object with the specified AWS Access Key ID, AWS Secret Key, and Amazon Glacier region endpoint.
CreateVault ( string vaultName ) : void	Creates a vault.
CreateVaultAsync ( string vaultName ) : System.Threading.Task	Creates a vault.
DeleteArchive ( string vaultName, string archiveId ) : void	Deletes an archive specified by vault name and archive ID.
DeleteArchiveAsync ( string vaultName, string archiveId ) : System.Threading.Task	Deletes an archive specified by vault name and archive ID.
DeleteVault ( string vaultName ) : void	Deletes the specified vault. Before deletion, the vault must be empty of all archives.
DeleteVaultAsync ( string vaultName ) : System.Threading.Task	Deletes the specified vault. Before deletion, the vault must be empty of all archives.
Dispose ( ) : void	Disposes of all managed and unmanaged resources.
Download ( string vaultName, string archiveId, string filePath ) : void	Downloads an archive from Amazon Glacier from the specified vault for the current user's account. Saves the archive to the specified file. This method creates an Amazon SNS topic, and an Amazon SQS queue that is subscribed to that topic. It then initiates the archive retrieval job and polls the queue for the archive to be available. This polling takes about 4 hours. Once the archive is available, download will begin. Additional options can be set using the UploadDirectoryOptions object. For example, you can set the FilesTransferProgress property to a delegate to track progress.
Download ( string vaultName, string archiveId, string filePath, DownloadOptions options ) : void	Downloads an archive from Amazon Glacier from the specified vault for the current user's account. Saves the archive to the specified file. This method creates an Amazon SNS topic, and an Amazon SQS queue that is subscribed to that topic. It then initiates the archive retrieval job and polls the queue for the archive to be available. This polling takes about 4 hours. Once the archive is available, download will begin. Additional options can be set using the UploadDirectoryOptions object. For example, you can set the FilesTransferProgress property to a delegate to track progress.
DownloadAsync ( string vaultName, string archiveId, string filePath ) : System.Threading.Task	Downloads an Amazon Glacier archive from the specified vault for the current user's account. Saves the archive to the specified file. This method creates an Amazon SNS topic, and an Amazon SQS queue that is subscribed to that topic. It then initiates the archive retrieval job and polls the queue for the archive to be available. This polling takes about 4 hours. Once the archive is available, download will begin.
DownloadAsync ( string vaultName, string archiveId, string filePath, DownloadOptions options ) : System.Threading.Task	Downloads an archive from Amazon Glacier from the specified vault for the current user's account. Saves the archive to the specified file. This method creates an Amazon SNS topic, and an Amazon SQS queue that is subscribed to that topic. It then initiates the archive retrieval job and polls the queue for the archive to be available. This polling takes about 4 hours. Once the archive is available, download will begin. Additional options can be set using the UploadDirectoryOptions object. For example, you can set the FilesTransferProgress property to a delegate to track progress.
DownloadJob ( string vaultName, string jobId, string filePath ) : void	Downloads the results from a completed archive retrieval. Saves the job output to the specified file. If there is an error during download the download will be retried from the last point read. Once the download is complete the checksum will be compared.
DownloadJob ( string vaultName, string jobId, string filePath, DownloadOptions options ) : void	Downloads the results from a completed archive retrieval. Saves the job output to the specified file. If there is an error during download the download will be retried from the last point read. Once the download is complete the checksum will be compared.
DownloadJobAsync ( string vaultName, string jobId, string filePath ) : System.Threading.Task	Downloads the results from a completed archive retrieval. Saves the job output to the specified file. If there is an error during download the download will be retried from the last point read. Once the download is complete the checksum will be compared.
DownloadJobAsync ( string vaultName, string jobId, string filePath, DownloadOptions options ) : System.Threading.Task	Downloads the results from a completed archive retrieval. Saves the job output to the specified file. If there is an error during download the download will be retried from the last point read. Once the download is complete the checksum will be compared.
InitiateArchiveRetrievalJob ( string vaultName, string archiveId ) : string	This method initiates an archive retieval job for the specified archive and returns back the job id. Once the job is complete
InitiateArchiveRetrievalJob ( string vaultName, string archiveId, InitiateArchiveRetrievalOptions options ) : string	This method initiates an archive retieval job for the specified archive and returns back the job id. Once the job is complete
InitiateArchiveRetrievalJobAsync ( string vaultName, string archiveId ) : Task	This method initiates an archive retieval job for the specified archive and returns back the job id. Once the job is complete
InitiateArchiveRetrievalJobAsync ( string vaultName, string archiveId, InitiateArchiveRetrievalOptions options ) : Task	This method initiates an archive retieval job for the specified archive and returns back the job id. Once the job is complete
Upload ( string vaultName, string archiveDescription, string filepath ) : UploadResult	Uploads the specified file to Amazon Glacier for archival storage in the specified vault in the specified user's account. For small archives, this method uploads the archive directly to Glacier. For larger archives, this method uses Glacier's multipart upload API to split the upload into multiple parts for better error recovery if any errors are encountered while streaming the data to Amazon Glacier.
Upload ( string vaultName, string archiveDescription, string filepath, UploadOptions options ) : UploadResult	Uploads the specified file to Amazon Glacier for archival storage in the specified vault in the specified user's account. For small archives, this method uploads the archive directly to Glacier. For larger archives, this method uses Glacier's multipart upload API to split the upload into multiple parts for better error recovery if any errors are encountered while streaming the data to Amazon Glacier.
UploadAsync ( string vaultName, string archiveDescription, string filepath ) : Task	Uploads the specified file to Amazon Glacier for archival storage in the specified vault in the specified user's account. For small archives, this method uploads the archive directly to Glacier. For larger archives, this method uses Glacier's multipart upload API to split the upload into multiple parts for better error recovery if any errors are encountered while streaming the data to Amazon Glacier.
UploadAsync ( string vaultName, string archiveDescription, string filepath, UploadOptions options ) : Task	Uploads the specified file to Amazon Glacier for archival storage in the specified vault in the specified user's account. For small archives, this method uploads the archive directly to Glacier. For larger archives, this method uses Glacier's multipart upload API to split the upload into multiple parts for better error recovery if any errors are encountered while streaming the data to Amazon Glacier.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Implements the Dispose pattern

Method Details

ArchiveTransferManager() public method

Constructs an ArchiveTransferManager object using the specified AWS credentials and Amazon Glacier region endpoint.

public ArchiveTransferManager ( AWSCredentials credentials, RegionEndpoint region ) : System
credentials	Amazon.Runtime.AWSCredentials	AWS Credentials
region	RegionEndpoint	Amazon Glacier region endpoint
return	System

ArchiveTransferManager() public method

Constructs an ArchiveTransferManager object using an existing Amazon Glacier client.

public ArchiveTransferManager ( IAmazonGlacier glacier ) : System
glacier	IAmazonGlacier	An AmazonGlacier client that used to make service calls.
return	System

ArchiveTransferManager() public method

Constructs an ArchiveTransferManager object for the specified Amazon Glacier region endpoint using the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

 <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration>

public ArchiveTransferManager ( RegionEndpoint region ) : System
region	RegionEndpoint	Amazon Glacier region endpoint
return	System

ArchiveTransferManager() public method

Constructs an ArchiveTransferManager object with the specified AWS Access Key ID, AWS Secret Key, and Amazon Glacier region endpoint.

public ArchiveTransferManager ( string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region ) : System
awsAccessKeyId	string	AWS Access Key ID
awsSecretAccessKey	string	AWS Secret Access Key
region	RegionEndpoint	Amazon Glacier region endpoint
return	System

CreateVault() public method

Creates a vault.

public CreateVault ( string vaultName ) : void
vaultName	string	The name of the vault to create.
return	void

CreateVaultAsync() public method

Creates a vault.

public CreateVaultAsync ( string vaultName ) : System.Threading.Task
vaultName	string	The name of the vault to create.
return	System.Threading.Task

DeleteArchive() public method

Deletes an archive specified by vault name and archive ID.

public DeleteArchive ( string vaultName, string archiveId ) : void
vaultName	string	The name of the vault containing the archive.
archiveId	string	The archive ID of the archive to delete.
return	void

DeleteArchiveAsync() public method

Deletes an archive specified by vault name and archive ID.

public DeleteArchiveAsync ( string vaultName, string archiveId ) : System.Threading.Task
vaultName	string	The name of the vault containing the archive.
archiveId	string	The archive ID of the archive to delete.
return	System.Threading.Task

DeleteVault() public method

Deletes the specified vault. Before deletion, the vault must be empty of all archives.

public DeleteVault ( string vaultName ) : void
vaultName	string	The name of the vault to delete.
return	void

DeleteVaultAsync() public method

Deletes the specified vault. Before deletion, the vault must be empty of all archives.

public DeleteVaultAsync ( string vaultName ) : System.Threading.Task
vaultName	string	The name of the vault to delete.
return	System.Threading.Task

Dispose() public method

Disposes of all managed and unmanaged resources.

public Dispose ( ) : void
return	void

Dispose() protected method

Implements the Dispose pattern

protected Dispose ( bool disposing ) : void
disposing	bool	Whether this object is being disposed via a call to Dispose /// or garbage collected.
return	void

Download() public method

Downloads an archive from Amazon Glacier from the specified vault for the current user's account. Saves the archive to the specified file.

This method creates an Amazon SNS topic, and an Amazon SQS queue that is subscribed to that topic. It then initiates the archive retrieval job and polls the queue for the archive to be available. This polling takes about 4 hours. Once the archive is available, download will begin.

Additional options can be set using the UploadDirectoryOptions object. For example, you can set the FilesTransferProgress property to a delegate to track progress.

public Download ( string vaultName, string archiveId, string filePath ) : void
vaultName	string	The name of the vault to download the archive from.
archiveId	string	The unique ID of the archive to download.
filePath	string	The file path to save the archive at.
return	void

Download() public method

Downloads an archive from Amazon Glacier from the specified vault for the current user's account. Saves the archive to the specified file.

Additional options can be set using the UploadDirectoryOptions object. For example, you can set the FilesTransferProgress property to a delegate to track progress.

public Download ( string vaultName, string archiveId, string filePath, DownloadOptions options ) : void
vaultName	string	The name of the vault to download the archive from.
archiveId	string	The unique ID of the archive to download.
filePath	string	The file path to save the archive at.
options	DownloadOptions	Additional options that can be used for the download.
return	void

DownloadAsync() public method

Downloads an Amazon Glacier archive from the specified vault for the current user's account. Saves the archive to the specified file.

public DownloadAsync ( string vaultName, string archiveId, string filePath ) : System.Threading.Task
vaultName	string	The name of the vault to download the archive from.
archiveId	string	The unique ID of the archive to download.
filePath	string	The file path to save the archive to.
return	System.Threading.Task

DownloadAsync() public method

Downloads an archive from Amazon Glacier from the specified vault for the current user's account. Saves the archive to the specified file.

Additional options can be set using the UploadDirectoryOptions object. For example, you can set the FilesTransferProgress property to a delegate to track progress.

public DownloadAsync ( string vaultName, string archiveId, string filePath, DownloadOptions options ) : System.Threading.Task
vaultName	string	The name of the vault to download the archive from.
archiveId	string	The unique ID of the archive to download.
filePath	string	The file path to save the archive at.
options	DownloadOptions	Additional options that can be used for the download.
return	System.Threading.Task

DownloadJob() public method

Downloads the results from a completed archive retrieval. Saves the job output to the specified file.

If there is an error during download the download will be retried from the last point read. Once the download is complete the checksum will be compared.

public DownloadJob ( string vaultName, string jobId, string filePath ) : void
vaultName	string	The name of the vault to download the job output from.
jobId	string	The unique job ID for an archive retrieval job.
filePath	string	The file path to save the job output at.
return	void

DownloadJob() public method

Downloads the results from a completed archive retrieval. Saves the job output to the specified file.

If there is an error during download the download will be retried from the last point read. Once the download is complete the checksum will be compared.

public DownloadJob ( string vaultName, string jobId, string filePath, DownloadOptions options ) : void
vaultName	string	The name of the vault to download the job output from.
jobId	string	The unique job ID for an archive retrieval job.
filePath	string	The file path to save the job output at.
options	DownloadOptions	Additional options that can be used for the download.
return	void

DownloadJobAsync() public method

Downloads the results from a completed archive retrieval. Saves the job output to the specified file.

If there is an error during download the download will be retried from the last point read. Once the download is complete the checksum will be compared.

public DownloadJobAsync ( string vaultName, string jobId, string filePath ) : System.Threading.Task
vaultName	string	The name of the vault to download the job output from.
jobId	string	The unique job ID for an archive retrieval job.
filePath	string	The file path to save the job output at.
return	System.Threading.Task

DownloadJobAsync() public method

Downloads the results from a completed archive retrieval. Saves the job output to the specified file.

If there is an error during download the download will be retried from the last point read. Once the download is complete the checksum will be compared.

public DownloadJobAsync ( string vaultName, string jobId, string filePath, DownloadOptions options ) : System.Threading.Task
vaultName	string	The name of the vault to download the job output from.
jobId	string	The unique job ID for an archive retrieval job.
filePath	string	The file path to save the job output at.
options	DownloadOptions	Additional options that can be used for the download.
return	System.Threading.Task

InitiateArchiveRetrievalJob() public method

This method initiates an archive retieval job for the specified archive and returns back the job id. Once the job is complete

public InitiateArchiveRetrievalJob ( string vaultName, string archiveId ) : string
vaultName	string	The name of the vault that contains the archive to initiate the job for.
archiveId	string	The archive id that the download job will retrieve.
return	string

InitiateArchiveRetrievalJob() public method

This method initiates an archive retieval job for the specified archive and returns back the job id. Once the job is complete

public InitiateArchiveRetrievalJob ( string vaultName, string archiveId, InitiateArchiveRetrievalOptions options ) : string
vaultName	string	The name of the vault that contains the archive to initiate the job for.
archiveId	string	The archive id that the download job will retrieve.
options	InitiateArchiveRetrievalOptions	Additional options that can be used for initiating archive retrieval.
return	string

InitiateArchiveRetrievalJobAsync() public method

This method initiates an archive retieval job for the specified archive and returns back the job id. Once the job is complete

public InitiateArchiveRetrievalJobAsync ( string vaultName, string archiveId ) : Task
vaultName	string	The name of the vault that contains the archive to initiate the job for.
archiveId	string	The archive id that the download job will retrieve.
return	Task

InitiateArchiveRetrievalJobAsync() public method

This method initiates an archive retieval job for the specified archive and returns back the job id. Once the job is complete

public InitiateArchiveRetrievalJobAsync ( string vaultName, string archiveId, InitiateArchiveRetrievalOptions options ) : Task
vaultName	string	The name of the vault that contains the archive to initiate the job for.
archiveId	string	The archive id that the download job will retrieve.
options	InitiateArchiveRetrievalOptions	Additional options that can be used for initiating archive retrieval.
return	Task

Upload() public method

Uploads the specified file to Amazon Glacier for archival storage in the specified vault in the specified user's account. For small archives, this method uploads the archive directly to Glacier. For larger archives, this method uses Glacier's multipart upload API to split the upload into multiple parts for better error recovery if any errors are encountered while streaming the data to Amazon Glacier.

public Upload ( string vaultName, string archiveDescription, string filepath ) : UploadResult
vaultName	string	The name of the vault to upload the file to.
archiveDescription	string	A description for the archive.
filepath	string	The file path to the file to upload.
return	UploadResult

Upload() public method

public Upload ( string vaultName, string archiveDescription, string filepath, UploadOptions options ) : UploadResult
vaultName	string	The name of the vault to download the archive from.
archiveDescription	string	A description for the archive.
filepath	string	The file path to the file to upload.
options	UploadOptions	Additional options that can be used for the upload.
return	UploadResult

UploadAsync() public method

public UploadAsync ( string vaultName, string archiveDescription, string filepath ) : Task
vaultName	string	The name of the vault to upload the file to.
archiveDescription	string	A description for the archive.
filepath	string	The file path to the file to upload.
return	Task

UploadAsync() public method

public UploadAsync ( string vaultName, string archiveDescription, string filepath, UploadOptions options ) : Task
vaultName	string	The name of the vault to download the archive from.
archiveDescription	string	A description for the archive.
filepath	string	The file path to the file to upload.
options	UploadOptions	Additional options that can be used for the upload.
return	Task