Edit

IStorage.ClearStateAsync Method

  • Reference

Definition

Namespace:
Orleans.Core
Assembly:
Orleans.dll
Assembly:
Orleans.Core.Abstractions.dll
Package:
Microsoft.Orleans.Core v1.5.10
Package:
Microsoft.Orleans.Core.Abstractions v3.6.5
Package:
Microsoft.Orleans.Core.Abstractions v7.2.5
Package:
Microsoft.Orleans.Core.Abstractions v8.0.0
Package:
Microsoft.Orleans.Core.Abstractions v8.1.0
Source:
IStorage.cs

Clears the grain state.

public System.Threading.Tasks.Task ClearStateAsync ();
abstract member ClearStateAsync : unit -> System.Threading.Tasks.Task
Public Function ClearStateAsync () As Task

Returns

Task

A Task representing the operation.

Remarks

This will usually mean the state record is deleted from backing store, but the specific behavior is defined by the storage provider instance configured for this grain. If the Etag does not match what is present in the backing store, then this operation will fail; Set Etag to null to indicate "always delete".

Applies to