IObjectStorageProviderUpdateContainerMetadata Method |
Updates the metadata associated with the container. This method is used to add, update, and
remove metadata items associated with a storage container.
Namespace: net.openstack.Core.ProvidersAssembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntax void UpdateContainerMetadata(
string container,
Dictionary<string, string> metadata,
string region = null,
bool useInternalUrl = false,
CloudIdentity identity = null
)
Sub UpdateContainerMetadata (
container As String,
metadata As Dictionary(Of String, String),
Optional region As String = Nothing,
Optional useInternalUrl As Boolean = false,
Optional identity As CloudIdentity = Nothing
)
void UpdateContainerMetadata(
String^ container,
Dictionary<String^, String^>^ metadata,
String^ region = nullptr,
bool useInternalUrl = false,
CloudIdentity^ identity = nullptr
)
abstract UpdateContainerMetadata :
container : string *
metadata : Dictionary<string, string> *
?region : string *
?useInternalUrl : bool *
?identity : CloudIdentity
(* Defaults:
let _region = defaultArg region null
let _useInternalUrl = defaultArg useInternalUrl false
let _identity = defaultArg identity null
*)
-> unit
Parameters
- container
- Type: SystemString
The container name. - metadata
- Type: System.Collections.GenericDictionaryString, String
The account metadata to update. - region (Optional)
- Type: SystemString
The region in which to execute this action. If not specified, the user's default region will be used. - 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 metadata is . |
ArgumentException |
If container is empty.
-or- If metadata contains two equivalent keys when compared using OrdinalIgnoreCase. -or- If metadata contains a key or value with invalid characters. -or- If metadata contains a key that is or empty. |
ContainerNameException | If container is not a valid container name. |
NotSupportedException |
If the provider does not support the given identity type.
-or- If metadata contains a key or value with characters that are not supported by the implementation. -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. |
ResponseException | If the REST API request failed. |
Remarks
Each key/value pair in metadata represents an updated metadata item.
If the value is or empty, then the metadata item represented by the key is
removed if it exists. If a metadata item already exists for the key, its value is updated.
Otherwise, a new metadata item is added for the key/value pair.
Version Information .NET Framework
Supported in: 4.5
openstack.net
Supported in: 1.6, 1.5, 1.4, 1.3.6
See Also