IComputeProviderWaitForImageState Method (String, ImageState, ImageState, Int32, NullableTimeSpan, ActionInt32, String, CloudIdentity) |
Waits for the image to enter a specified state.
Namespace: net.openstack.Core.ProvidersAssembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntax ServerImage WaitForImageState(
string imageId,
ImageState expectedState,
ImageState[] errorStates,
int refreshCount = 600,
Nullable<TimeSpan> refreshDelay = null,
Action<int> progressUpdatedCallback = null,
string region = null,
CloudIdentity identity = null
)
Function WaitForImageState (
imageId As String,
expectedState As ImageState,
errorStates As ImageState(),
Optional refreshCount As Integer = 600,
Optional refreshDelay As Nullable(Of TimeSpan) = Nothing,
Optional progressUpdatedCallback As Action(Of Integer) = Nothing,
Optional region As String = Nothing,
Optional identity As CloudIdentity = Nothing
) As ServerImage
ServerImage^ WaitForImageState(
String^ imageId,
ImageState^ expectedState,
array<ImageState^>^ errorStates,
int refreshCount = 600,
Nullable<TimeSpan> refreshDelay = nullptr,
Action<int>^ progressUpdatedCallback = nullptr,
String^ region = nullptr,
CloudIdentity^ identity = nullptr
)
abstract WaitForImageState :
imageId : string *
expectedState : ImageState *
errorStates : ImageState[] *
?refreshCount : int *
?refreshDelay : Nullable<TimeSpan> *
?progressUpdatedCallback : Action<int> *
?region : string *
?identity : CloudIdentity
(* Defaults:
let _refreshCount = defaultArg refreshCount 600
let _refreshDelay = defaultArg refreshDelay null
let _progressUpdatedCallback = defaultArg progressUpdatedCallback null
let _region = defaultArg region null
let _identity = defaultArg identity null
*)
-> ServerImage
Parameters
- imageId
- Type: SystemString
The image ID. This is obtained from SimpleServerImage.Id. - expectedState
- Type: net.openstack.Core.DomainImageState
The expected state. - errorStates
- Type: net.openstack.Core.DomainImageState
The error state(s) in which to throw an exception if the image enters. - refreshCount (Optional)
- Type: SystemInt32
Number of times to poll the image's status. - refreshDelay (Optional)
- Type: SystemNullableTimeSpan
The time to wait between polling requests for the image status. If this value is , the default is 2.4 seconds. - progressUpdatedCallback (Optional)
- Type: SystemActionInt32
A callback delegate to execute each time the Progress value increases. If this value is , progress updates are not reported. - 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:
ServerImageA
ServerImage object containing the image details, including the final
Status.
Exceptions Remarks Notes to Callers |
---|
This is a blocking operation and will not return until the image enters either the expected state, an error state, or the retry count is exceeded.
|
Version Information .NET Framework
Supported in: 4.5
openstack.net
Supported in: 1.6, 1.5, 1.4, 1.3.6
See Also