IReliableDictionary3<TKey,TValue>.TryGetVersionedKeyValuePairAsync Method
Definition
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.
Overloads
| TryGetVersionedKeyValuePairAsync(ITransaction, TKey) |
(Beta) Attempts to get the versioned element associated with the specified key from the Reliable Dictionary. |
| TryGetVersionedKeyValuePairAsync(ITransaction, TKey, LockMode) |
(Beta) Attempts to get the versioned element associated with the specified key from the Reliable Dictionary. |
| TryGetVersionedKeyValuePairAsync(ITransaction, TKey, LockMode, TimeSpan, CancellationToken) |
(Beta) Attempts to get the versioned element associated with the specified key from the Reliable Dictionary. |
TryGetVersionedKeyValuePairAsync(ITransaction, TKey)
(Beta) Attempts to get the versioned element associated with the specified key from the Reliable Dictionary.
public System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.ConditionalValue<Microsoft.ServiceFabric.Data.VersionedKeyValuePair<TKey,TValue>>> TryGetVersionedKeyValuePairAsync (Microsoft.ServiceFabric.Data.ITransaction tx, TKey key);abstract member TryGetVersionedKeyValuePairAsync : Microsoft.ServiceFabric.Data.ITransaction * 'Key -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.ConditionalValue<Microsoft.ServiceFabric.Data.VersionedKeyValuePair<'Key, 'Value>>>Public Function TryGetVersionedKeyValuePairAsync (tx As ITransaction, key As TKey) As Task(Of ConditionalValue(Of VersionedKeyValuePair(Of TKey, TValue)))Parameters
- tx
- ITransaction
Transaction to associate this operation with.
- key
- TKey
The key of the versioned element to get.
Returns
A task that represents the asynchronous read operation. The task result is a tuple indicating whether the key was found in the Reliable Dictionary and if found, the value and sequence number.
Exceptions
tx is null, or key is null or cannot be serialized.
The operation failed to complete within the given timeout.
The operation was canceled.
Indicates that the IReliableDictionary cannot serve reads at the moment. This exception can be thrown in all ReplicaRoles. One reason it may be thrown in the Primary role is loss of ReadStatus. One reason it may be thrown in the ActiveSecondary role is that Reliable Collection's state is not yet consistent.
The transaction has been internally faulted by the system. Retry the operation on a new transaction
Thrown when a method call is invalid for the object's current state. Example, transaction used is already terminated: committed or aborted by the user. If this exception is thrown, it is highly likely that there is a bug in the service code of the use of transactions.
Indicates that the Reliable Dictionary is closed or deleted.
Applies to
TryGetVersionedKeyValuePairAsync(ITransaction, TKey, LockMode)
(Beta) Attempts to get the versioned element associated with the specified key from the Reliable Dictionary.
public System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.ConditionalValue<Microsoft.ServiceFabric.Data.VersionedKeyValuePair<TKey,TValue>>> TryGetVersionedKeyValuePairAsync (Microsoft.ServiceFabric.Data.ITransaction tx, TKey key, Microsoft.ServiceFabric.Data.Collections.LockMode lockMode);abstract member TryGetVersionedKeyValuePairAsync : Microsoft.ServiceFabric.Data.ITransaction * 'Key * Microsoft.ServiceFabric.Data.Collections.LockMode -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.ConditionalValue<Microsoft.ServiceFabric.Data.VersionedKeyValuePair<'Key, 'Value>>>Public Function TryGetVersionedKeyValuePairAsync (tx As ITransaction, key As TKey, lockMode As LockMode) As Task(Of ConditionalValue(Of VersionedKeyValuePair(Of TKey, TValue)))Parameters
- tx
- ITransaction
Transaction to associate this operation with.
- key
- TKey
The key of the versioned element to get.
- lockMode
- LockMode
Type of locking to use for this read operation.
Returns
A task that represents the asynchronous read operation. The task result is a tuple indicating whether the key was found in the Reliable Dictionary and if found, the value and sequence number.
Exceptions
tx is null, or key is null or cannot be serialized.
The operation failed to complete within the given timeout.
The operation was canceled.
Indicates that the IReliableDictionary cannot serve reads at the moment. This exception can be thrown in all ReplicaRoles. One reason it may be thrown in the Primary role is loss of ReadStatus. One reason it may be thrown in the ActiveSecondary role is that Reliable Collection's state is not yet consistent.
The transaction has been internally faulted by the system. Retry the operation on a new transaction
Thrown when a method call is invalid for the object's current state. Example, transaction used is already terminated: committed or aborted by the user. If this exception is thrown, it is highly likely that there is a bug in the service code of the use of transactions.
Indicates that the Reliable Dictionary is closed or deleted.
Applies to
TryGetVersionedKeyValuePairAsync(ITransaction, TKey, LockMode, TimeSpan, CancellationToken)
(Beta) Attempts to get the versioned element associated with the specified key from the Reliable Dictionary.
public System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.ConditionalValue<Microsoft.ServiceFabric.Data.VersionedKeyValuePair<TKey,TValue>>> TryGetVersionedKeyValuePairAsync (Microsoft.ServiceFabric.Data.ITransaction tx, TKey key, Microsoft.ServiceFabric.Data.Collections.LockMode lockMode, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);abstract member TryGetVersionedKeyValuePairAsync : Microsoft.ServiceFabric.Data.ITransaction * 'Key * Microsoft.ServiceFabric.Data.Collections.LockMode * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.ConditionalValue<Microsoft.ServiceFabric.Data.VersionedKeyValuePair<'Key, 'Value>>>Public Function TryGetVersionedKeyValuePairAsync (tx As ITransaction, key As TKey, lockMode As LockMode, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ConditionalValue(Of VersionedKeyValuePair(Of TKey, TValue)))Parameters
- tx
- ITransaction
Transaction to associate this operation with.
- key
- TKey
The key of the versioned element to get.
- lockMode
- LockMode
Type of locking to use for this read operation.
- 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.
- cancellationToken
- CancellationToken
The token to monitor for cancellation requests. The default is None.
Returns
A task that represents the asynchronous read operation. The task result is a tuple indicating whether the key was found in the Reliable Dictionary and if found, the value and sequence number.
Exceptions
tx is null, or key is null or cannot be serialized.
timeout is negative.
The operation failed to complete within the given timeout.
The operation was canceled.
Indicates that the IReliableDictionary cannot serve reads at the moment. This exception can be thrown in all ReplicaRoles. One reason it may be thrown in the Primary role is loss of ReadStatus. One reason it may be thrown in the ActiveSecondary role is that Reliable Collection's state is not yet consistent.
The transaction has been internally faulted by the system. Retry the operation on a new transaction
Thrown when a method call is invalid for the object's current state. Example, transaction used is already terminated: committed or aborted by the user. If this exception is thrown, it is highly likely that there is a bug in the service code of the use of transactions.
Indicates that the Reliable Dictionary is closed or deleted.
