Take (remove) objects from the space matching their IDs, the specified class type and routing key, with the
provided .
Note, if routing key is null and the cluster is partitioned, the operation will broadcast to all of the partitions.
FIFO is not supported by this operation - the results are always ordered in correlation with the input IDs array.
Declaration Syntax
C# | Visual Basic | Visual C++ | J# |
ITakeByIdsResult<Object> TakeByIds( Type type, Object[] ids, Object routingKey, ITransaction tx, TakeModifiers modifiers )
Function TakeByIds ( _ type As Type, _ ids As Object(), _ routingKey As Object, _ tx As ITransaction, _ modifiers As TakeModifiers _ ) As ITakeByIdsResult(Of Object)
ITakeByIdsResult<Object^>^ TakeByIds( Type^ type, array<Object^>^ ids, Object^ routingKey, ITransaction^ tx, TakeModifiers modifiers )
ITakeByIdsResult<Object> TakeByIds( Type type, Object[] ids, Object routingKey, ITransaction tx, TakeModifiers modifiers )
Parameters
- type (Type)
- The class.
- ids (array<Object>[]()[][])
- The object IDs array.
- routingKey (Object)
- The routing key of the provided object IDs.
- tx (ITransaction)
- The transaction which this operation will participate in.
- modifiers (TakeModifiers)
- The read modifier to use (One or several of ).
Return Value
An ITakeByIdsResult<(Of <(<'T>)>)> reference containing the matched results.
Exceptions
Exception | Condition |
---|---|
TakeByIdsException | The operation had a failure. |