Click or drag to resize
CloudFilesProviderExtractArchiveFromFile Method
This API is preliminary and subject to change.
Upload and automatically extract an archive of files.

Namespace: net.openstack.Providers.Rackspace
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntax
public ExtractArchiveResponse ExtractArchiveFromFile(
	string filePath,
	string uploadPath,
	ArchiveFormat archiveFormat,
	string contentType = null,
	int chunkSize = 4096,
	Dictionary<string, string> headers = null,
	string region = null,
	Action<long> progressUpdated = null,
	bool useInternalUrl = false,
	CloudIdentity identity = null
)

Parameters

filePath
Type: SystemString
The source file path. Example c:\folder1\folder2\archive_name.tar.gz
uploadPath
Type: SystemString
The target path for the extracted files. For details about this value, see the Extract Archive reference link in the documentation for this method.
archiveFormat
Type: net.openstack.Providers.Rackspace.ObjectsArchiveFormat
The archive format.
contentType (Optional)
Type: SystemString
The content type of the files extracted from the archive. If the value is or empty, the content type of the extracted files is unspecified.
chunkSize (Optional)
Type: SystemInt32
The buffer size to use for copying streaming data.
headers (Optional)
Type: System.Collections.GenericDictionaryString, String
A collection of custom HTTP headers to associate with the object (see GetObjectHeaders(String, String, String, Boolean, CloudIdentity)).
region (Optional)
Type: SystemString
The region in which to execute this action. If not specified, the user's default region will be used.
progressUpdated (Optional)
Type: SystemActionInt64
A callback for progress updates. If the value is , no progress updates are reported.
useInternalUrl (Optional)
Type: SystemBoolean
to use the endpoint's InternalURL; otherwise to use the endpoint's PublicURL.
identity (Optional)
Type: net.openstack.Core.DomainCloudIdentity
The cloud identity to use for this request. If not specified, the default identity for the current provider instance will be used.

Return Value

Type: ExtractArchiveResponse
An ExtractArchiveResponse object containing the detailed result of the extract archive operation.
Exceptions
ExceptionCondition
ArgumentNullException If filePath is .

-or-

If uploadPath is .

-or-

If archiveFormat is .

ArgumentException If filePath is empty.

-or-

If headers contains two equivalent keys when compared using OrdinalIgnoreCase.

ArgumentOutOfRangeExceptionIf chunkSize is less than 0.
FileNotFoundExceptionIf the file filePath could not be found.
NotSupportedException If the provider does not support the given identity type.

-or-

The specified archiveFormat is not supported by the provider.

-or-

The specified region is not supported.

-or-

useInternalUrl is and the provider does not support internal URLs.

InvalidOperationException If identity is and no default identity is available for the provider.

-or-

If region is and no default region is available for the provider.

ResponseExceptionIf the REST API request failed.
Version Information

.NET Framework

Supported in: 4.5

openstack.net

Supported in: 1.6, 1.5, 1.4, 1.3.6
See Also