ReliableStateManager.IReliableStateManager.RemoveAsync Method

Definition

Namespace:

Microsoft.ServiceFabric.Data

Assembly:

Microsoft.ServiceFabric.Data.dll

Package:

Microsoft.ServiceFabric.Data v6.1.1583

Overloads

IReliableStateManager.RemoveAsync(ITransaction, Uri, TimeSpan)	Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed.
IReliableStateManager.RemoveAsync(String, TimeSpan)	Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas.
IReliableStateManager.RemoveAsync(Uri, TimeSpan)	Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas.
IReliableStateManager.RemoveAsync(ITransaction, Uri)	Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed.
IReliableStateManager.RemoveAsync(ITransaction, String)	Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed.
IReliableStateManager.RemoveAsync(Uri)	Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas.
IReliableStateManager.RemoveAsync(String)	Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas.
IReliableStateManager.RemoveAsync(ITransaction, String, TimeSpan)	Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed.

IReliableStateManager.RemoveAsync(ITransaction, Uri, TimeSpan)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed.

System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (Microsoft.ServiceFabric.Data.ITransaction tx, Uri name, TimeSpan timeout);

abstract member Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Microsoft.ServiceFabric.Data.ITransaction * Uri * TimeSpan -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Microsoft.ServiceFabric.Data.ITransaction * Uri * TimeSpan -> System.Threading.Tasks.Task

Function RemoveAsync (tx As ITransaction, name As Uri, timeout As TimeSpan) As Task Implements IReliableStateManager.RemoveAsync

Parameters

tx

ITransaction

Transaction to associate this operation with.

name

Uri

The name of the IReliableState to remove.

timeout

TimeSpan

The amount of time to wait for the operation to complete before throwing a TimeoutException. Primarily used to prevent deadlocks. The default is 4 seconds.

Returns

Task

Task that represents the asynchronous remove operation.

Implements

RemoveAsync(ITransaction, Uri, TimeSpan)

Exceptions

ArgumentNullException

tx is null, or name is null.

ArgumentException

An IReliableState with the given name does not exist, or timeout is negative.

TimeoutException

The operation failed to complete within the given timeout.

FabricNotPrimaryException

Thrown when the IReliableStateManager is not in Primary.

InvalidOperationException

Thrown when a method call is invalid for the object's current state. For example, transaction used is already terminated: committed or aborted.

FabricObjectClosedException

Indicates that the Reliable State Manager is closed.

Remarks

This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact. If this method throws an exception, the transaction must be aborted.

IReliableStateManager.RemoveAsync(String, TimeSpan)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas.

System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (string name, TimeSpan timeout);

abstract member Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : string * TimeSpan -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : string * TimeSpan -> System.Threading.Tasks.Task

Function RemoveAsync (name As String, timeout As TimeSpan) As Task Implements IReliableStateManager.RemoveAsync

Parameters

name

String

The name of the IReliableState to remove.

timeout

TimeSpan

The amount of time to wait for the operation to complete before throwing a TimeoutException. Primarily used to prevent deadlocks. The default is 4 seconds.

Returns

Task

Task that represents the asynchronous remove operation.

Implements

RemoveAsync(String, TimeSpan)

Exceptions

ArgumentNullException

name is null.

ArgumentException

An IReliableState with the given name does not exist, or timeout is negative.

TimeoutException

The operation failed to complete within the given timeout.

FabricNotPrimaryException

Thrown when the IReliableStateManager is not in Primary.

FabricObjectClosedException

Indicates that the Reliable State Manager is closed.

Remarks

This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact.

IReliableStateManager.RemoveAsync(Uri, TimeSpan)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas.

System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (Uri name, TimeSpan timeout);

abstract member Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Uri * TimeSpan -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Uri * TimeSpan -> System.Threading.Tasks.Task

Function RemoveAsync (name As Uri, timeout As TimeSpan) As Task Implements IReliableStateManager.RemoveAsync

Parameters

name

Uri

The name of the IReliableState to remove.

timeout

TimeSpan

The amount of time to wait for the operation to complete before throwing a TimeoutException. Primarily used to prevent deadlocks. The default is 4 seconds.

Returns

Task

Task that represents the asynchronous remove operation.

Implements

RemoveAsync(Uri, TimeSpan)

Exceptions

ArgumentNullException

name is null.

ArgumentException

An IReliableState with the given name does not exist, or timeout is negative.

TimeoutException

The operation failed to complete within the given timeout.

FabricNotPrimaryException

Thrown when the IReliableStateManager is not in Primary.

FabricObjectClosedException

Indicates that the Reliable State Manager is closed.

Remarks

This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact.

IReliableStateManager.RemoveAsync(ITransaction, Uri)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed.

System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (Microsoft.ServiceFabric.Data.ITransaction tx, Uri name);

abstract member Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Microsoft.ServiceFabric.Data.ITransaction * Uri -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Microsoft.ServiceFabric.Data.ITransaction * Uri -> System.Threading.Tasks.Task

Function RemoveAsync (tx As ITransaction, name As Uri) As Task Implements IReliableStateManager.RemoveAsync

Parameters

tx

ITransaction

Transaction to associate this operation with.

name

Uri

The name of the IReliableState to remove.

Returns

Task

Task that represents the asynchronous remove operation.

Implements

RemoveAsync(ITransaction, Uri)

Exceptions

ArgumentNullException

tx is null, or name is null.

ArgumentException

An IReliableState with the given name does not exist.

TimeoutException

The operation failed to complete within the default timeout.

FabricNotPrimaryException

Thrown when the IReliableStateManager is not in Primary.

InvalidOperationException

Thrown when a method call is invalid for the object's current state. For example, transaction used is already terminated: committed or aborted.

FabricObjectClosedException

Indicates that the Reliable State Manager is closed.

Remarks

This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact. If this method throws an exception, the transaction must be aborted.

IReliableStateManager.RemoveAsync(ITransaction, String)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed.

System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (Microsoft.ServiceFabric.Data.ITransaction tx, string name);

abstract member Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Microsoft.ServiceFabric.Data.ITransaction * string -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Microsoft.ServiceFabric.Data.ITransaction * string -> System.Threading.Tasks.Task

Function RemoveAsync (tx As ITransaction, name As String) As Task Implements IReliableStateManager.RemoveAsync

Parameters

tx

ITransaction

Transaction to associate this operation with.

name

String

The name of the IReliableState to remove.

Returns

Task

Task that represents the asynchronous remove operation.

Implements

RemoveAsync(ITransaction, String)

Exceptions

ArgumentNullException

tx is null, or name is null.

ArgumentException

An IReliableState with the given name does not exist.

TimeoutException

The operation failed to complete within the default timeout.

FabricNotPrimaryException

Thrown when the IReliableStateManager is not in Primary.

InvalidOperationException

Thrown when a method call is invalid for the object's current state. For example, transaction used is already terminated: committed or aborted.

FabricObjectClosedException

Indicates that the Reliable State Manager is closed.

Remarks

This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact. If this method throws an exception, the transaction must be aborted.

IReliableStateManager.RemoveAsync(Uri)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas.

System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (Uri name);

abstract member Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Uri -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Uri -> System.Threading.Tasks.Task

Function RemoveAsync (name As Uri) As Task Implements IReliableStateManager.RemoveAsync

Parameters

name

Uri

The name of the IReliableState to remove.

Returns

Task

Task that represents the asynchronous remove operation.

Implements

RemoveAsync(Uri)

Exceptions

ArgumentNullException

name is null.

ArgumentException

An IReliableState with the given name does not exist.

TimeoutException

The operation failed to complete within the default timeout.

FabricNotPrimaryException

Thrown when the IReliableStateManager is not in Primary.

FabricObjectClosedException

Indicates that the Reliable State Manager is closed.

Remarks

This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact.

IReliableStateManager.RemoveAsync(String)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas.

System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (string name);

abstract member Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : string -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : string -> System.Threading.Tasks.Task

Function RemoveAsync (name As String) As Task Implements IReliableStateManager.RemoveAsync

Parameters

name

String

The name of the IReliableState to remove.

Returns

Task

Task that represents the asynchronous remove operation.

Implements

RemoveAsync(String)

Exceptions

ArgumentNullException

name is null.

ArgumentException

An IReliableState with the given name does not exist.

TimeoutException

The operation failed to complete within the default timeout.

FabricNotPrimaryException

Thrown when the IReliableStateManager is not in Primary.

FabricObjectClosedException

Indicates that the Reliable State Manager is closed.

Remarks

This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact.

IReliableStateManager.RemoveAsync(ITransaction, String, TimeSpan)

Removes the IReliableState with the given name from this state manager. The state is permanently removed from persistent storage and all replicas when the transaction is committed.

System.Threading.Tasks.Task IReliableStateManager.RemoveAsync (Microsoft.ServiceFabric.Data.ITransaction tx, string name, TimeSpan timeout);

abstract member Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Microsoft.ServiceFabric.Data.ITransaction * string * TimeSpan -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Data.IReliableStateManager.RemoveAsync : Microsoft.ServiceFabric.Data.ITransaction * string * TimeSpan -> System.Threading.Tasks.Task

Function RemoveAsync (tx As ITransaction, name As String, timeout As TimeSpan) As Task Implements IReliableStateManager.RemoveAsync

Parameters

tx

ITransaction

Transaction to associate this operation with.

name

String

The name of the IReliableState to remove.

timeout

TimeSpan

The amount of time to wait for the operation to complete before throwing a TimeoutException. Primarily used to prevent deadlocks. The default is 4 seconds.

Returns

Task

Task that represents the asynchronous remove operation.

Implements

RemoveAsync(ITransaction, String, TimeSpan)

Exceptions

ArgumentNullException

tx is null, or name is null.

ArgumentException

An IReliableState with the given name does not exist, or timeout is negative.

TimeoutException

The operation failed to complete within the given timeout.

FabricNotPrimaryException

Thrown when the IReliableStateManager is not in Primary.

InvalidOperationException

Thrown when a method call is invalid for the object's current state. For example, transaction used is already terminated: committed or aborted.

FabricObjectClosedException

Indicates that the Reliable State Manager is closed.

Remarks

This is an atomic operation. The IReliableState will be successfully removed along with all state or be left in-tact. If this method throws an exception, the transaction must be aborted.