Click or drag to resize
IBlockStorageProviderWaitForSnapshotState Method
Waits for a snapshot to be set to be set to a particular status.

Namespace: net.openstack.Core.Providers
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntax
Snapshot WaitForSnapshotState(
	string snapshotId,
	SnapshotState expectedState,
	SnapshotState[] errorStates,
	int refreshCount = 60,
	Nullable<TimeSpan> refreshDelay = null,
	string region = null,
	CloudIdentity identity = null
)

Parameters

snapshotId
Type: SystemString
The ID of the snapshot to poll. The value should be obtained from Snapshot.Id.
expectedState
Type: net.openstack.Core.DomainSnapshotState
The expected state for the snapshot.
errorStates
Type: net.openstack.Core.DomainSnapshotState
The error state(s) in which to stop polling once reached.
refreshCount (Optional)
Type: SystemInt32
The number of times to poll the snapshot.
refreshDelay (Optional)
Type: SystemNullableTimeSpan
The refresh delay. If the value is , the default value is 10 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: Snapshot
A Snapshot object containing the snapshot details, including the final Status.
Exceptions
ExceptionCondition
ArgumentNullException If snapshotId is .

-or-

If expectedState is .

-or-

If errorStates is .

ArgumentException If snapshotId 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.

SnapshotEnteredErrorStateExceptionIf the method returned due to the snapshot entering one of the errorStates.
ResponseExceptionIf the REST API request failed.
Remarks
This method can be used to ensure that a snapshot is in an intended state 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