CloudFilesProviderExtractArchive Method |
This API is preliminary and subject to change.
Upload and automatically extract an archive of files.
Namespace: net.openstack.Providers.RackspaceAssembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntax public ExtractArchiveResponse ExtractArchive(
Stream stream,
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
)
Public Function ExtractArchive (
stream As Stream,
uploadPath As String,
archiveFormat As ArchiveFormat,
Optional contentType As String = Nothing,
Optional chunkSize As Integer = 4096,
Optional headers As Dictionary(Of String, String) = Nothing,
Optional region As String = Nothing,
Optional progressUpdated As Action(Of Long) = Nothing,
Optional useInternalUrl As Boolean = false,
Optional identity As CloudIdentity = Nothing
) As ExtractArchiveResponse
public:
ExtractArchiveResponse^ ExtractArchive(
Stream^ stream,
String^ uploadPath,
ArchiveFormat^ archiveFormat,
String^ contentType = nullptr,
int chunkSize = 4096,
Dictionary<String^, String^>^ headers = nullptr,
String^ region = nullptr,
Action<long long>^ progressUpdated = nullptr,
bool useInternalUrl = false,
CloudIdentity^ identity = nullptr
)
member ExtractArchive :
stream : Stream *
uploadPath : string *
archiveFormat : ArchiveFormat *
?contentType : string *
?chunkSize : int *
?headers : Dictionary<string, string> *
?region : string *
?progressUpdated : Action<int64> *
?useInternalUrl : bool *
?identity : CloudIdentity
(* Defaults:
let _contentType = defaultArg contentType null
let _chunkSize = defaultArg chunkSize 4096
let _headers = defaultArg headers null
let _region = defaultArg region null
let _progressUpdated = defaultArg progressUpdated null
let _useInternalUrl = defaultArg useInternalUrl false
let _identity = defaultArg identity null
*)
-> ExtractArchiveResponse
Parameters
- stream
- Type: System.IOStream
A Stream providing the data for the archive. - 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:
ExtractArchiveResponseAn
ExtractArchiveResponse object containing the detailed result of the extract archive operation.
Exceptions Version Information .NET Framework
Supported in: 4.5
openstack.net
Supported in: 1.6, 1.5, 1.4, 1.3.6
See Also