Metaspace.Space.Options

Description

Options functions

Functions

NameSignature and Synopsis
createPutOptionsObject createPutOptions ()
Used to instantiate an instance of a PutOptions object.
createTakeOptionsObject createTakeOptions()
Used to instantiate an instance of a TakeOptions object.
getLockWaitlong getLockWait (Object options)
Retrieve the current setting for the amount of time to wait for the lock on the key of an existing tuple.
getTTLlong getTTL (Object options)
Retrieve the current setting for the number of milliseconds to use as an entry's time to live.
isForgetboolean isForget (Object options)
For TakeOptions - Retrieve the current setting for whether or not to return the tuple taken from a space using this TakeOptions object.
For PutOptions -Retrieve whether tuples, which already exist in a space, should be returned as the return values of put operations, or whether the existing tuples should be "forgotten" and not returned.
isLockboolean isLock (Object options)
For TakeOptions - Retrieve the current setting for whether or not to lock the key of a tuple after it is removed from a space.
For PutOptions - Retrieve whether or not to lock the key of a tuple after it is stored into the space.
isUnlockboolean isUnlock (Object options)
For TakeOptions - Retrieve the current setting for whether or not to unlock the key of a tuple after it is removed from a space.
For PutOptions - Retrieve whether or not to unlock the key of a tuple after it is stored into a space.
setForgetObject setForget (Object options, boolean forget)
For TakeOptions - Specify whether or not to return the tuple taken from a space using this TakeOptions object.
For PutOptions - Specifies whether a tuple, which already exists in the space, should be returned as the return value of a put operation.
setLockObject setLock (Object options, boolean lock)
For TakeOptions - Specify whether or not to lock the key of a tuple after it is removed from a space.
For PutOptions - Specify whether or not to lock the key of a tuple after the tuple has been stored in a space.
setLockWaitObject setLockWait (Object options, long lockWait)
For TakeOptions - Specify the amount of time to wait to acquire the lock on an existing locked tuple.
For PutOptions - Specify the amount of time to wait to acquire the lock on the key of an existing tuple.
setTTLObject setTTL (Object options, long ttl)
Specify the time to live for entries stored into a space using this PutOptions object. WAIT_FOREVER means that an entry will never expire.
setUnlockObject setUnlock (Object options, boolean unlock)
For TakeOptions - Specify whether or not to unlock the key of a tuple after it is removed from a space.
For PutOptions - Specify whether or not to unlock the key after storing a tuple into a space