Click or drag to resize
IComputeProviderWaitForImageState Method (String, ImageState, ImageState, Int32, NullableTimeSpan, ActionInt32, String, CloudIdentity)
Waits for the image to enter any one of a set of specified states.

Namespace: net.openstack.Core.Providers
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntax
ServerImage WaitForImageState(
	string imageId,
	ImageState[] expectedStates,
	ImageState[] errorStates,
	int refreshCount = 600,
	Nullable<TimeSpan> refreshDelay = null,
	Action<int> progressUpdatedCallback = null,
	string region = null,
	CloudIdentity identity = null
)

Parameters

imageId
Type: SystemString
The image ID. This is obtained from SimpleServerImage.Id.
expectedStates
Type: net.openstack.Core.DomainImageState
The expected state(s).
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: ServerImage
A ServerImage object containing the image details, including the final Status.
Exceptions
ExceptionCondition
ArgumentNullException If imageId is .

-or-

If expectedStates is .

-or-

If errorStates is .

ArgumentException If imageId is empty.

-or-

If expectedStates is empty.

ArgumentOutOfRangeException If refreshCount is less than 0.

-or-

If refreshDelay is negative.

NotSupportedException If the provider does not support the given identity type.

-or-

The specified region is not supported.

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.

ImageEnteredErrorStateExceptionIf the method returned due to the image entering one of the errorStates.
ResponseExceptionIf the REST API request failed.
Remarks
Note Notes to Callers
This is a blocking operation and will not return until the image enters either an 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