IBlockStorageProviderWaitForVolumeAvailable Method |
Waits for a volume to be set to
Available status.
Namespace: net.openstack.Core.ProvidersAssembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntax Volume WaitForVolumeAvailable(
string volumeId,
int refreshCount = 600,
Nullable<TimeSpan> refreshDelay = null,
string region = null,
CloudIdentity identity = null
)
Function WaitForVolumeAvailable (
volumeId As String,
Optional refreshCount As Integer = 600,
Optional refreshDelay As Nullable(Of TimeSpan) = Nothing,
Optional region As String = Nothing,
Optional identity As CloudIdentity = Nothing
) As Volume
Volume^ WaitForVolumeAvailable(
String^ volumeId,
int refreshCount = 600,
Nullable<TimeSpan> refreshDelay = nullptr,
String^ region = nullptr,
CloudIdentity^ identity = nullptr
)
abstract WaitForVolumeAvailable :
volumeId : string *
?refreshCount : int *
?refreshDelay : Nullable<TimeSpan> *
?region : string *
?identity : CloudIdentity
(* Defaults:
let _refreshCount = defaultArg refreshCount 600
let _refreshDelay = defaultArg refreshDelay null
let _region = defaultArg region null
let _identity = defaultArg identity null
*)
-> Volume
Parameters
- volumeId
- Type: SystemString
The ID of the volume to poll. The value should be obtained from Volume.Id. - refreshCount (Optional)
- Type: SystemInt32
The number of times to poll for the volume to become available. - refreshDelay (Optional)
- Type: SystemNullableTimeSpan
The refresh delay. If the value is , the default value is 2.4 seconds. - region (Optional)
- Type: SystemString
The region in which to execute this action. If not specified, the user's default region will be used. - 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:
VolumeA
Volume object containing the details of the volume, including the final
Status.
Exceptions Remarks
This method can be used to ensure that a volume is correctly created prior to executing additional requests against it.
Version Information .NET Framework
Supported in: 4.5
openstack.net
Supported in: 1.6, 1.5, 1.4, 1.3.6
See Also