ResultCode (aerospike-client 4.2.1 API)

java.lang.Object
- com.aerospike.client.ResultCode

```
public final class ResultCode
extends Object
```
Database operation error codes. The positive numbers align with the server side file proto.h.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALWAYS_FORBIDDEN` Operation not allowed in current configuration.
`static int`	`ASYNC_QUEUE_FULL` Async delay queue is full.
`static int`	`BATCH_DISABLED` Batch functionality has been disabled.
`static int`	`BATCH_MAX_REQUESTS_EXCEEDED` Batch max requests have been exceeded.
`static int`	`BATCH_QUEUES_FULL` All batch queues are full.
`static int`	`BIN_EXISTS_ERROR` On create-only (write unique) operations on a bin that already exists.
`static int`	`BIN_NAME_TOO_LONG` Bin name length greater than 14 characters or maximum bins exceeded.
`static int`	`BIN_NOT_FOUND` Specified bin name does not exist in record.
`static int`	`BIN_TYPE_ERROR` Operation is not supported with configured bin type (single-bin or multi-bin).
`static int`	`CLIENT_ERROR` Generic client error.
`static int`	`CLUSTER_KEY_MISMATCH` Expected cluster was not received.
`static int`	`COMMAND_REJECTED` Asynchronous max concurrent database commands have been exceeded and therefore rejected.
`static int`	`DEVICE_OVERLOAD` Device not keeping up with writes.
`static int`	`ELEMENT_EXISTS` Map element exists in CREATE_ONLY write mode.
`static int`	`ELEMENT_NOT_FOUND` Map element not found in UPDATE_ONLY write mode.
`static int`	`EXPIRED_PASSWORD` Password has expired.
`static int`	`FAIL_FORBIDDEN` Operation not allowed at this time.
`static int`	`FORBIDDEN_PASSWORD` Forbidden password (e.g.
`static int`	`GENERATION_ERROR` On modifying a record with unexpected generation.
`static int`	`ILLEGAL_STATE` Security protocol not followed.
`static int`	`INDEX_ALREADY_EXISTS` Secondary index already exists.
`static int`	`INDEX_FOUND`
`static int`	`INDEX_GENERIC` Generic secondary index error.
`static int`	`INDEX_MAXCOUNT` Maximum number of indicies exceeded.
`static int`	`INDEX_NAME_MAXLEN` Index name maximum length exceeded.
`static int`	`INDEX_NOTFOUND` Requested secondary index does not exist.
`static int`	`INDEX_NOTREADABLE` Secondary index not available.
`static int`	`INDEX_OOM` Secondary index memory space exceeded.
`static int`	`INVALID_COMMAND` Administration command is invalid.
`static int`	`INVALID_CREDENTIAL` Security credential is invalid.
`static int`	`INVALID_FIELD` Administration field is invalid.
`static int`	`INVALID_NAMESPACE` Invalid namespace.
`static int`	`INVALID_NODE_ERROR` Chosen node is not currently active.
`static int`	`INVALID_PASSWORD` Password is invalid.
`static int`	`INVALID_PRIVILEGE` Privilege is invalid.
`static int`	`INVALID_ROLE` Role name is invalid.
`static int`	`INVALID_USER` User name is invalid.
`static int`	`KEY_BUSY` Too many concurrent operations on the same record.
`static int`	`KEY_EXISTS_ERROR` On create-only (write unique) operations on a record that already exists.
`static int`	`KEY_MISMATCH` Key type mismatch.
`static int`	`KEY_NOT_FOUND_ERROR` On retrieving, touching or replacing a record that doesn't exist.
`static int`	`LARGE_ITEM_NOT_FOUND` The requested item in a large collection was not found.
`static int`	`NO_MORE_CONNECTIONS` Max connections would be exceeded.
`static int`	`NOT_AUTHENTICATED` User must be authentication before performing database operations.
`static int`	`OK` Operation was successful.
`static int`	`PARAMETER_ERROR` Bad parameter(s) were passed in database operation call.
`static int`	`PARSE_ERROR` Client parse error.
`static int`	`PARTITION_UNAVAILABLE` Partition is unavailable.
`static int`	`QUERY_ABORTED` Secondary index query aborted.
`static int`	`QUERY_END` There are no more records left for query.
`static int`	`QUERY_GENERIC` Generic query error.
`static int`	`QUERY_QUEUEFULL` Secondary index queue full.
`static int`	`QUERY_TERMINATED` Query was terminated by user.
`static int`	`QUERY_TIMEOUT` Secondary index query timed out on server.
`static int`	`RECORD_TOO_BIG` Record size exceeds limit.
`static int`	`ROLE_ALREADY_EXISTS` Role already exists.
`static int`	`ROLE_VIOLATION` User does not possess the required role to perform the database operation.
`static int`	`SCAN_ABORT` Scan aborted by server.
`static int`	`SCAN_TERMINATED` Scan was terminated by user.
`static int`	`SECURITY_NOT_ENABLED` Security functionality not enabled by connected server.
`static int`	`SECURITY_NOT_SUPPORTED` Security functionality not supported by connected server.
`static int`	`SECURITY_SCHEME_NOT_SUPPORTED` Security type not supported by connected server.
`static int`	`SERIALIZE_ERROR` Client serialization error.
`static int`	`SERVER_ERROR` Unknown server failure.
`static int`	`SERVER_MEM_ERROR` Server has run out of memory.
`static int`	`SERVER_NOT_AVAILABLE` Server is not accepting requests.
`static int`	`TIMEOUT` Client or server has timed out.
`static int`	`UDF_BAD_RESPONSE` A user defined function returned an error code.
`static int`	`UNSUPPORTED_FEATURE` Unsupported Server Feature (e.g.
`static int`	`USER_ALREADY_EXISTS` User was previously created.

Constructor Summary

Constructors
Constructor and Description

ResultCode()

Constructors
Constructor and Description
`ResultCode()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`getResultString(int resultCode)` Return result code as a string.
`static boolean`	`keepConnection(int resultCode)` Should connection be put back into pool.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERIALIZE_ERROR
```
public static final int SERIALIZE_ERROR
```
    Client serialization error.
    
    See Also:
    
    Constant Field Values
  - ASYNC_QUEUE_FULL
```
public static final int ASYNC_QUEUE_FULL
```
    Async delay queue is full.
    
    See Also:
    
    Constant Field Values
  - SERVER_NOT_AVAILABLE
```
public static final int SERVER_NOT_AVAILABLE
```
    Server is not accepting requests.
    
    See Also:
    
    Constant Field Values
  - NO_MORE_CONNECTIONS
```
public static final int NO_MORE_CONNECTIONS
```
    Max connections would be exceeded. There are no more available connections.
    
    See Also:
    
    Constant Field Values
  - COMMAND_REJECTED
```
public static final int COMMAND_REJECTED
```
    Asynchronous max concurrent database commands have been exceeded and therefore rejected.
    
    See Also:
    
    Constant Field Values
  - QUERY_TERMINATED
```
public static final int QUERY_TERMINATED
```
    Query was terminated by user.
    
    See Also:
    
    Constant Field Values
  - SCAN_TERMINATED
```
public static final int SCAN_TERMINATED
```
    Scan was terminated by user.
    
    See Also:
    
    Constant Field Values
  - INVALID_NODE_ERROR
```
public static final int INVALID_NODE_ERROR
```
    Chosen node is not currently active.
    
    See Also:
    
    Constant Field Values
  - PARSE_ERROR
```
public static final int PARSE_ERROR
```
    Client parse error.
    
    See Also:
    
    Constant Field Values
  - CLIENT_ERROR
```
public static final int CLIENT_ERROR
```
    Generic client error.
    
    See Also:
    
    Constant Field Values
  - OK
```
public static final int OK
```
    Operation was successful.
    
    See Also:
    
    Constant Field Values
  - SERVER_ERROR
```
public static final int SERVER_ERROR
```
    Unknown server failure.
    
    See Also:
    
    Constant Field Values
  - KEY_NOT_FOUND_ERROR
```
public static final int KEY_NOT_FOUND_ERROR
```
    On retrieving, touching or replacing a record that doesn't exist.
    
    See Also:
    
    Constant Field Values
  - GENERATION_ERROR
```
public static final int GENERATION_ERROR
```
    On modifying a record with unexpected generation.
    
    See Also:
    
    Constant Field Values
  - PARAMETER_ERROR
```
public static final int PARAMETER_ERROR
```
    Bad parameter(s) were passed in database operation call.
    
    See Also:
    
    Constant Field Values
  - KEY_EXISTS_ERROR
```
public static final int KEY_EXISTS_ERROR
```
    On create-only (write unique) operations on a record that already exists.
    
    See Also:
    
    Constant Field Values
  - BIN_EXISTS_ERROR
```
public static final int BIN_EXISTS_ERROR
```
    On create-only (write unique) operations on a bin that already exists.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_KEY_MISMATCH
```
public static final int CLUSTER_KEY_MISMATCH
```
    Expected cluster was not received.
    
    See Also:
    
    Constant Field Values
  - SERVER_MEM_ERROR
```
public static final int SERVER_MEM_ERROR
```
    Server has run out of memory.
    
    See Also:
    
    Constant Field Values
  - TIMEOUT
```
public static final int TIMEOUT
```
    Client or server has timed out.
    
    See Also:
    
    Constant Field Values
  - ALWAYS_FORBIDDEN
```
public static final int ALWAYS_FORBIDDEN
```
    Operation not allowed in current configuration.
    
    See Also:
    
    Constant Field Values
  - PARTITION_UNAVAILABLE
```
public static final int PARTITION_UNAVAILABLE
```
    Partition is unavailable.
    
    See Also:
    
    Constant Field Values
  - BIN_TYPE_ERROR
```
public static final int BIN_TYPE_ERROR
```
    Operation is not supported with configured bin type (single-bin or multi-bin).
    
    See Also:
    
    Constant Field Values
  - RECORD_TOO_BIG
```
public static final int RECORD_TOO_BIG
```
    Record size exceeds limit.
    
    See Also:
    
    Constant Field Values
  - KEY_BUSY
```
public static final int KEY_BUSY
```
    Too many concurrent operations on the same record.
    
    See Also:
    
    Constant Field Values
  - SCAN_ABORT
```
public static final int SCAN_ABORT
```
    Scan aborted by server.
    
    See Also:
    
    Constant Field Values
  - UNSUPPORTED_FEATURE
```
public static final int UNSUPPORTED_FEATURE
```
    Unsupported Server Feature (e.g. Scan + UDF)
    
    See Also:
    
    Constant Field Values
  - BIN_NOT_FOUND
```
public static final int BIN_NOT_FOUND
```
    Specified bin name does not exist in record.
    
    See Also:
    
    Constant Field Values
  - DEVICE_OVERLOAD
```
public static final int DEVICE_OVERLOAD
```
    Device not keeping up with writes.
    
    See Also:
    
    Constant Field Values
  - KEY_MISMATCH
```
public static final int KEY_MISMATCH
```
    Key type mismatch.
    
    See Also:
    
    Constant Field Values
  - INVALID_NAMESPACE
```
public static final int INVALID_NAMESPACE
```
    Invalid namespace.
    
    See Also:
    
    Constant Field Values
  - BIN_NAME_TOO_LONG
```
public static final int BIN_NAME_TOO_LONG
```
    Bin name length greater than 14 characters or maximum bins exceeded.
    
    See Also:
    
    Constant Field Values
  - FAIL_FORBIDDEN
```
public static final int FAIL_FORBIDDEN
```
    Operation not allowed at this time.
    
    See Also:
    
    Constant Field Values
  - ELEMENT_NOT_FOUND
```
public static final int ELEMENT_NOT_FOUND
```
    Map element not found in UPDATE_ONLY write mode.
    
    See Also:
    
    Constant Field Values
  - ELEMENT_EXISTS
```
public static final int ELEMENT_EXISTS
```
    Map element exists in CREATE_ONLY write mode.
    
    See Also:
    
    Constant Field Values
  - QUERY_END
```
public static final int QUERY_END
```
    There are no more records left for query.
    
    See Also:
    
    Constant Field Values
  - SECURITY_NOT_SUPPORTED
```
public static final int SECURITY_NOT_SUPPORTED
```
    Security functionality not supported by connected server.
    
    See Also:
    
    Constant Field Values
  - SECURITY_NOT_ENABLED
```
public static final int SECURITY_NOT_ENABLED
```
    Security functionality not enabled by connected server.
    
    See Also:
    
    Constant Field Values
  - SECURITY_SCHEME_NOT_SUPPORTED
```
public static final int SECURITY_SCHEME_NOT_SUPPORTED
```
    Security type not supported by connected server.
    
    See Also:
    
    Constant Field Values
  - INVALID_COMMAND
```
public static final int INVALID_COMMAND
```
    Administration command is invalid.
    
    See Also:
    
    Constant Field Values
  - INVALID_FIELD
```
public static final int INVALID_FIELD
```
    Administration field is invalid.
    
    See Also:
    
    Constant Field Values
  - ILLEGAL_STATE
```
public static final int ILLEGAL_STATE
```
    Security protocol not followed.
    
    See Also:
    
    Constant Field Values
  - INVALID_USER
```
public static final int INVALID_USER
```
    User name is invalid.
    
    See Also:
    
    Constant Field Values
  - USER_ALREADY_EXISTS
```
public static final int USER_ALREADY_EXISTS
```
    User was previously created.
    
    See Also:
    
    Constant Field Values
  - INVALID_PASSWORD
```
public static final int INVALID_PASSWORD
```
    Password is invalid.
    
    See Also:
    
    Constant Field Values
  - EXPIRED_PASSWORD
```
public static final int EXPIRED_PASSWORD
```
    Password has expired.
    
    See Also:
    
    Constant Field Values
  - FORBIDDEN_PASSWORD
```
public static final int FORBIDDEN_PASSWORD
```
    Forbidden password (e.g. recently used)
    
    See Also:
    
    Constant Field Values
  - INVALID_CREDENTIAL
```
public static final int INVALID_CREDENTIAL
```
    Security credential is invalid.
    
    See Also:
    
    Constant Field Values
  - INVALID_ROLE
```
public static final int INVALID_ROLE
```
    Role name is invalid.
    
    See Also:
    
    Constant Field Values
  - ROLE_ALREADY_EXISTS
```
public static final int ROLE_ALREADY_EXISTS
```
    Role already exists.
    
    See Also:
    
    Constant Field Values
  - INVALID_PRIVILEGE
```
public static final int INVALID_PRIVILEGE
```
    Privilege is invalid.
    
    See Also:
    
    Constant Field Values
  - NOT_AUTHENTICATED
```
public static final int NOT_AUTHENTICATED
```
    User must be authentication before performing database operations.
    
    See Also:
    
    Constant Field Values
  - ROLE_VIOLATION
```
public static final int ROLE_VIOLATION
```
    User does not possess the required role to perform the database operation.
    
    See Also:
    
    Constant Field Values
  - UDF_BAD_RESPONSE
```
public static final int UDF_BAD_RESPONSE
```
    A user defined function returned an error code.
    
    See Also:
    
    Constant Field Values
  - LARGE_ITEM_NOT_FOUND
```
public static final int LARGE_ITEM_NOT_FOUND
```
    The requested item in a large collection was not found.
    
    See Also:
    
    Constant Field Values
  - BATCH_DISABLED
```
public static final int BATCH_DISABLED
```
    Batch functionality has been disabled.
    
    See Also:
    
    Constant Field Values
  - BATCH_MAX_REQUESTS_EXCEEDED
```
public static final int BATCH_MAX_REQUESTS_EXCEEDED
```
    Batch max requests have been exceeded.
    
    See Also:
    
    Constant Field Values
  - BATCH_QUEUES_FULL
```
public static final int BATCH_QUEUES_FULL
```
    All batch queues are full.
    
    See Also:
    
    Constant Field Values
  - INDEX_ALREADY_EXISTS
```
public static final int INDEX_ALREADY_EXISTS
```
    Secondary index already exists.
    
    See Also:
    
    Constant Field Values
  - INDEX_FOUND
```
public static final int INDEX_FOUND
```
    See Also:
    
    Constant Field Values
  - INDEX_NOTFOUND
```
public static final int INDEX_NOTFOUND
```
    Requested secondary index does not exist.
    
    See Also:
    
    Constant Field Values
  - INDEX_OOM
```
public static final int INDEX_OOM
```
    Secondary index memory space exceeded.
    
    See Also:
    
    Constant Field Values
  - INDEX_NOTREADABLE
```
public static final int INDEX_NOTREADABLE
```
    Secondary index not available.
    
    See Also:
    
    Constant Field Values
  - INDEX_GENERIC
```
public static final int INDEX_GENERIC
```
    Generic secondary index error.
    
    See Also:
    
    Constant Field Values
  - INDEX_NAME_MAXLEN
```
public static final int INDEX_NAME_MAXLEN
```
    Index name maximum length exceeded.
    
    See Also:
    
    Constant Field Values
  - INDEX_MAXCOUNT
```
public static final int INDEX_MAXCOUNT
```
    Maximum number of indicies exceeded.
    
    See Also:
    
    Constant Field Values
  - QUERY_ABORTED
```
public static final int QUERY_ABORTED
```
    Secondary index query aborted.
    
    See Also:
    
    Constant Field Values
  - QUERY_QUEUEFULL
```
public static final int QUERY_QUEUEFULL
```
    Secondary index queue full.
    
    See Also:
    
    Constant Field Values
  - QUERY_TIMEOUT
```
public static final int QUERY_TIMEOUT
```
    Secondary index query timed out on server.
    
    See Also:
    
    Constant Field Values
  - QUERY_GENERIC
```
public static final int QUERY_GENERIC
```
    Generic query error.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ResultCode
```
public ResultCode()
```
- Method Detail
  - keepConnection
```
public static boolean keepConnection(int resultCode)
```
    Should connection be put back into pool.
  - getResultString
```
public static String getResultString(int resultCode)
```
    Return result code as a string.

Class ResultCode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZE_ERROR

ASYNC_QUEUE_FULL

SERVER_NOT_AVAILABLE

NO_MORE_CONNECTIONS

COMMAND_REJECTED

QUERY_TERMINATED

SCAN_TERMINATED

INVALID_NODE_ERROR

PARSE_ERROR

CLIENT_ERROR

OK

SERVER_ERROR

KEY_NOT_FOUND_ERROR

GENERATION_ERROR

PARAMETER_ERROR

KEY_EXISTS_ERROR

BIN_EXISTS_ERROR

CLUSTER_KEY_MISMATCH

SERVER_MEM_ERROR

TIMEOUT

ALWAYS_FORBIDDEN

PARTITION_UNAVAILABLE

BIN_TYPE_ERROR

RECORD_TOO_BIG

KEY_BUSY

SCAN_ABORT

UNSUPPORTED_FEATURE

BIN_NOT_FOUND

DEVICE_OVERLOAD

KEY_MISMATCH

INVALID_NAMESPACE

BIN_NAME_TOO_LONG

FAIL_FORBIDDEN

ELEMENT_NOT_FOUND

ELEMENT_EXISTS

QUERY_END

SECURITY_NOT_SUPPORTED

SECURITY_NOT_ENABLED

SECURITY_SCHEME_NOT_SUPPORTED

INVALID_COMMAND

INVALID_FIELD

ILLEGAL_STATE

INVALID_USER

USER_ALREADY_EXISTS

INVALID_PASSWORD

EXPIRED_PASSWORD

FORBIDDEN_PASSWORD

INVALID_CREDENTIAL

INVALID_ROLE

ROLE_ALREADY_EXISTS

INVALID_PRIVILEGE

NOT_AUTHENTICATED

ROLE_VIOLATION

UDF_BAD_RESPONSE

LARGE_ITEM_NOT_FOUND

BATCH_DISABLED

BATCH_MAX_REQUESTS_EXCEEDED

BATCH_QUEUES_FULL

INDEX_ALREADY_EXISTS

INDEX_FOUND

INDEX_NOTFOUND

INDEX_OOM

INDEX_NOTREADABLE

INDEX_GENERIC

INDEX_NAME_MAXLEN

INDEX_MAXCOUNT

QUERY_ABORTED

QUERY_QUEUEFULL

QUERY_TIMEOUT

QUERY_GENERIC

Constructor Detail

ResultCode

Method Detail

keepConnection