Click or drag to resize
IObjectStorageProviderCreateObjectFromFile Method
Creates an object using data from a file. If the destination file already exists, the contents are overwritten.

Namespace: net.openstack.Core.Providers
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
void CreateObjectFromFile(
	string container,
	string filePath,
	string objectName = null,
	string contentType = null,
	int chunkSize = 65536,
	Dictionary<string, string> headers = null,
	string region = null,
	Action<long> progressUpdated = null,
	bool useInternalUrl = false,
	CloudIdentity identity = null


Type: SystemString
The container name.
Type: SystemString
The source file path. Example c:\folder1\folder2\image_name.jpeg
objectName (Optional)
Type: SystemString
The destination object name. If , the filename portion of filePath will be used.
contentType (Optional)
Type: SystemString
The content type of the created object. If the value is or empty, the content type of the created object 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.
ArgumentNullException If container is .


If filePath is .

ArgumentException If container is empty.


If filePath is empty.


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.
FileNotFoundExceptionIf the file filePath could not be found.
NotSupportedException If the provider does not support the given identity type.


The specified region is not supported.


useInternalUrl is and the provider does not support internal URLs.

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


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

ResponseExceptionIf the REST API request failed.

The content type for the object may be specified by providing the contentType argument, or by setting DetectContentType to True in the headers argument. If neither of these is used, the resulting content type of the object is unspecified.

Object metadata can be set at the time the object is created by including the custom metadata items in the headers argument. Note that unlike the UpdateObjectMetadata(String, String, DictionaryString, String, String, Boolean, CloudIdentity) method, the keys of all custom metadata items included as headers must be prefixed with ObjectMetaDataPrefix.

The following code shows two ways to create an object with custom metadata. The first uses the headers argument to this method, and the second shows an alternative method of calling UpdateObjectMetadata(String, String, DictionaryString, String, String, Boolean, CloudIdentity) after the object is created.
public void CreateObjectWithMetadata(
    IObjectStorageProvider provider,
    string containerName,
    string objectName,
    string filePath)
    // Method 1: Set metadata when the object is created
    var headers = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase)
        { CloudFilesProvider.ObjectMetaDataPrefix + "Key", "Value" }
    provider.CreateObjectFromFile(containerName, filePath, objectName, headers: headers);

    // Method 2: Set metadata in a separate call after the object is created
    provider.CreateObjectFromFile(containerName, filePath, objectName);
    var metadata = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase)
        { "Key", "Value" }
    provider.UpdateObjectMetadata(containerName, objectName, metadata);
Version Information

.NET Framework

Supported in: 4.5

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