IObjectStorageProviderGetObject Method |
Gets an object, writing the data to the specified
Stream.
Namespace: net.openstack.Core.ProvidersAssembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntax void GetObject(
string container,
string objectName,
Stream outputStream,
int chunkSize = 65536,
Dictionary<string, string> headers = null,
string region = null,
bool verifyEtag = false,
Action<long> progressUpdated = null,
bool useInternalUrl = false,
CloudIdentity identity = null
)
Sub GetObject (
container As String,
objectName As String,
outputStream As Stream,
Optional chunkSize As Integer = 65536,
Optional headers As Dictionary(Of String, String) = Nothing,
Optional region As String = Nothing,
Optional verifyEtag As Boolean = false,
Optional progressUpdated As Action(Of Long) = Nothing,
Optional useInternalUrl As Boolean = false,
Optional identity As CloudIdentity = Nothing
)
void GetObject(
String^ container,
String^ objectName,
Stream^ outputStream,
int chunkSize = 65536,
Dictionary<String^, String^>^ headers = nullptr,
String^ region = nullptr,
bool verifyEtag = false,
Action<long long>^ progressUpdated = nullptr,
bool useInternalUrl = false,
CloudIdentity^ identity = nullptr
)
abstract GetObject :
container : string *
objectName : string *
outputStream : Stream *
?chunkSize : int *
?headers : Dictionary<string, string> *
?region : string *
?verifyEtag : bool *
?progressUpdated : Action<int64> *
?useInternalUrl : bool *
?identity : CloudIdentity
(* Defaults:
let _chunkSize = defaultArg chunkSize 65536
let _headers = defaultArg headers null
let _region = defaultArg region null
let _verifyEtag = defaultArg verifyEtag false
let _progressUpdated = defaultArg progressUpdated null
let _useInternalUrl = defaultArg useInternalUrl false
let _identity = defaultArg identity null
*)
-> unit
Parameters
- container
- Type: SystemString
The container name. - objectName
- Type: SystemString
The source object name. Example image_name.jpeg - outputStream
- Type: System.IOStream
The output stream. - 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 include with the request. - region (Optional)
- Type: SystemString
The region in which to execute this action. If not specified, the user's default region will be used. - verifyEtag (Optional)
- Type: SystemBoolean
If and the object includes an ETag, the retrieved data will be verified before returning. - 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.
Exceptions Exception | Condition |
---|
ArgumentNullException |
If container is .
-or- If objectName is . -or- If outputStream is . |
ArgumentException |
If container is empty.
-or- If objectName is empty. -or- If headers contains two equivalent keys when compared using OrdinalIgnoreCase. |
ContainerNameException | If container is not a valid container name. |
ObjectNameException | If objectName is not a valid object name. |
ArgumentOutOfRangeException | If chunkSize is less than 0. |
NotSupportedException |
If the provider does not support the given identity type.
-or- verifyEtag is , the object is a static or dynamic large object, and the provider implementation does not support verifying ETags for large objects. -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. |
InvalidETagException | If verifyEtag is , the object includes an ETag header, and the downloaded data does not match the ETag header value. |
ResponseException | If the REST API request failed. |
Remarks
This call returns information for the first replicant of the object located in the distributed storage
system. If changes were made to the specified object that are not yet fully replicated through the
storage system, the results of this call may not match the most recent information uploaded to Object
Storage. To force the system to locate the most recent replica instead, set
Newest to
"True" in the
headers argument.
Version Information .NET Framework
Supported in: 4.5
openstack.net
Supported in: 1.6, 1.5, 1.4, 1.3.6
See Also