Package com.apple.foundationdb.record.provider.foundationdb

Enum FDBTransactionPriority

java.lang.Object

java.lang.Enum<FDBTransactionPriority>

com.apple.foundationdb.record.provider.foundationdb.FDBTransactionPriority

All Implemented Interfaces:

Serializable, Comparable<FDBTransactionPriority>

@API(MAINTAINED)
public enum FDBTransactionPriority
extends Enum<FDBTransactionPriority>

An enum indicating the priority of transactions against FoundationDB. This value can then be used to set options on the transaction to indicate to the database the priority of the transaction's work.

This API is MAINTAINED, but it may add additional values if they become available.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BATCH	The priority level that should be used for batch operations.
DEFAULT	The default priority level for most transactions.
SYSTEM_IMMEDIATE	The priority level for system operations.

Method Summary

Modifier and Type	Method	Description
static FDBTransactionPriority	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FDBTransactionPriority[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BATCH

public static final FDBTransactionPriority BATCH

The priority level that should be used for batch operations. This should be used for discretionary work such as background jobs that do not have strict time pressure to complete in the near future. For example online index builds and statistics collection should often happen at batch priority. This signals to the database that this work should be rate limited at a higher rate if it would impact work done at a higher priority.

DEFAULT

public static final FDBTransactionPriority DEFAULT

The default priority level for most transactions. This should be used for most work unless BATCH priority is more appropriate. The system will apply normal rate limiting and throttling mechanisms to the transaction.

SYSTEM_IMMEDIATE

public static final FDBTransactionPriority SYSTEM_IMMEDIATE

The priority level for system operations. This is used internally within FoundationDB for operations that must complete immediately for all operations, and it bypasses any rate limiting. For this reason, it should generally not be used by users of the system, and it is included mainly for completeness.

Method Detail

values

public static FDBTransactionPriority[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FDBTransactionPriority c : FDBTransactionPriority.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FDBTransactionPriority valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null