Click or drag to resize
IObjectStorageProvider.GetObject Method
Gets an object, writing the data to the specified Stream.

Namespace: net.openstack.Core.Providers
Assembly: 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
)

Parameters

container
Type: System.String
The container name.
objectName
Type: System.String
The source object name. Example image_name.jpeg
outputStream
Type: System.IO.Stream
The output stream.
chunkSize (Optional)
Type: System.Int32
The buffer size to use for copying streaming data.
headers (Optional)
Type: System.Collections.Generic.Dictionary<String, String>
A collection of custom HTTP headers to include with the request.
region (Optional)
Type: System.String
The region in which to execute this action. If not specified, the user's default region will be used.
verifyEtag (Optional)
Type: System.Boolean
If true and the object includes an ETag, the retrieved data will be verified before returning.
progressUpdated (Optional)
Type: System.Action<Int64>
A callback for progress updates. If the value is null, no progress updates are reported.
useInternalUrl (Optional)
Type: System.Boolean
true to use the endpoint's InternalURL; otherwise false to use the endpoint's PublicURL.
identity (Optional)
Type: net.openstack.Core.Domain.CloudIdentity
The cloud identity to use for this request. If not specified, the default identity for the current provider instance will be used.
Exceptions
ExceptionCondition
ArgumentNullException If container is null.

-or-

If objectName is null.

-or-

If outputStream is null.

ArgumentException If container is empty.

-or-

If objectName is empty.

-or-

If headers contains two equivalent keys when compared using OrdinalIgnoreCase.

ContainerNameExceptionIf container is not a valid container name.
ObjectNameExceptionIf objectName is not a valid object name.
ArgumentOutOfRangeExceptionIf chunkSize is less than 0.
NotSupportedException If the provider does not support the given identity type.

-or-

verifyEtag is true, 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 true and the provider does not support internal URLs.

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

-or-

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

InvalidETagExceptionIf verifyEtag is true, the object includes an ETag header, and the downloaded data does not match the ETag header value.
ResponseExceptionIf 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