ComputeServiceWaitForImageStatusAsync Method |
Waits for an image to reach the specified state.
Namespace: OpenStack.Compute.v2_1Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntax public Task<Image> WaitForImageStatusAsync(
Identifier imageId,
ImageStatus status,
Nullable<TimeSpan> refreshDelay = null,
Nullable<TimeSpan> timeout = null,
IProgress<bool> progress = null,
CancellationToken cancellationToken = null
)
Public Function WaitForImageStatusAsync (
imageId As Identifier,
status As ImageStatus,
Optional refreshDelay As Nullable(Of TimeSpan) = Nothing,
Optional timeout As Nullable(Of TimeSpan) = Nothing,
Optional progress As IProgress(Of Boolean) = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of Image)
public:
Task<Image^>^ WaitForImageStatusAsync(
Identifier^ imageId,
ImageStatus^ status,
Nullable<TimeSpan> refreshDelay = nullptr,
Nullable<TimeSpan> timeout = nullptr,
IProgress<bool>^ progress = nullptr,
CancellationToken cancellationToken = nullptr
)
member WaitForImageStatusAsync :
imageId : Identifier *
status : ImageStatus *
?refreshDelay : Nullable<TimeSpan> *
?timeout : Nullable<TimeSpan> *
?progress : IProgress<bool> *
?cancellationToken : CancellationToken
(* Defaults:
let _refreshDelay = defaultArg refreshDelay null
let _timeout = defaultArg timeout null
let _progress = defaultArg progress null
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<Image>
Parameters
- imageId
- Type: OpenStackIdentifier
The image identifier. - status
- Type: OpenStack.Images.v2ImageStatus
The image status. - refreshDelay (Optional)
- Type: SystemNullableTimeSpan
The amount of time to wait between requests. - timeout (Optional)
- Type: SystemNullableTimeSpan
The amount of time to wait before throwing a TimeoutException. - progress (Optional)
- Type: SystemIProgressBoolean
The progress callback. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Return Value
Type:
TaskImageExceptions Version Information .NET Framework
Supported in: 4.5
openstack.net
Supported in: 1.6
See Also