IActorStateProvider.SaveStateAsync Method

Reference

Definition

Namespace:: Microsoft.ServiceFabric.Actors.Runtime

Assembly:: Microsoft.ServiceFabric.Actors.dll

Package:: Microsoft.ServiceFabric.Actors v6.1.1583

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Saves the specified set of actor state changes for the specified actor ID atomically.

public System.Threading.Tasks.Task SaveStateAsync (Microsoft.ServiceFabric.Actors.ActorId actorId, System.Collections.Generic.IReadOnlyCollection<Microsoft.ServiceFabric.Actors.Runtime.ActorStateChange> stateChanges, System.Threading.CancellationToken cancellationToken = default);

abstract member SaveStateAsync : Microsoft.ServiceFabric.Actors.ActorId * System.Collections.Generic.IReadOnlyCollection<Microsoft.ServiceFabric.Actors.Runtime.ActorStateChange> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function SaveStateAsync (actorId As ActorId, stateChanges As IReadOnlyCollection(Of ActorStateChange), Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

actorId: ActorId

ID of the actor for which to save the state changes.

stateChanges: IReadOnlyCollection<ActorStateChange>

Collection of state changes to save.

cancellationToken: CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A task that represents the asynchronous save operation.

Exceptions

InvalidOperationException

When StateChangeKind is None

OperationCanceledException

The operation was canceled.

Remarks

The collection of state changes should contain only one item for a given state name. The save operation will fail on trying to add an actor state which already exists or update/remove an actor state which does not exist.

Applies to