com.aerospike.client.policy

Class Policy

java.lang.Object

com.aerospike.client.policy.Policy

Direct Known Subclasses:

BatchPolicy, QueryPolicy, ScanPolicy, WritePolicy

public class Policy
extends Object

Container object for transaction policy attributes used in all database operation calls.

Field Summary

Fields

Modifier and Type	Field and Description
ConsistencyLevel	consistencyLevel How replicas should be consulted in a read operation to provide the desired consistency guarantee.
int	maxRetries Maximum number of retries before aborting the current transaction.
Priority	priority Priority of request relative to other transactions.
Replica	replica Send read commands to the node containing the key's partition replica type.
boolean	sendKey Send user defined key in addition to hash digest on both reads and writes.
int	sleepBetweenRetries Milliseconds to sleep between retries if a transaction fails and the timeout was not exceeded.
int	timeout Total transaction timeout in milliseconds for both client and server.

Constructor Summary

Constructors

Constructor and Description
Policy() Default constructor.
Policy(Policy other) Copy policy from another policy.

Method Summary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

priority

public Priority priority

Priority of request relative to other transactions. Currently, only used for scans.

consistencyLevel

public ConsistencyLevel consistencyLevel

How replicas should be consulted in a read operation to provide the desired consistency guarantee. Default to allowing one replica to be used in the read operation.

replica

public Replica replica

Send read commands to the node containing the key's partition replica type. Write commands are not affected by this setting, because all writes are directed to the node containing the key's master partition.

Default to sending read commands to the node containing the key's master partition.

timeout

public int timeout

Total transaction timeout in milliseconds for both client and server. The timeout is tracked on the client and also sent to the server along with the transaction in the wire protocol. The client will most likely timeout first, but the server has the capability to timeout the transaction as well.

The timeout is also used as a socket timeout. Retries will not occur if the timeout limit has been reached. Default to no timeout (0).

maxRetries

public int maxRetries

Maximum number of retries before aborting the current transaction. A retry is attempted when there is a network error other than timeout. If maxRetries is exceeded, the abort will occur even if the timeout has not yet been exceeded. The default number of retries is 1.

sleepBetweenRetries

public int sleepBetweenRetries

Milliseconds to sleep between retries if a transaction fails and the timeout was not exceeded. Enter zero to skip sleep. The default sleep between retries is 500 ms.

sendKey

public boolean sendKey

Send user defined key in addition to hash digest on both reads and writes. The default is to not send the user defined key.

Constructor Detail

Policy

public Policy(Policy other)

Copy policy from another policy.

Policy

public Policy()

Default constructor.