Enum Class OracleNoSQLConfigurations

java.lang.Object
java.lang.Enum<OracleNoSQLConfigurations>
org.eclipse.jnosql.databases.oracle.communication.OracleNoSQLConfigurations
All Implemented Interfaces:
Serializable, Comparable<OracleNoSQLConfigurations>, Constable, Supplier<String>

public enum OracleNoSQLConfigurations extends Enum<OracleNoSQLConfigurations> implements Supplier<String>
An enumeration representing the available configuration options for connecting to the Oracle NoSQL database. Each option implements the Supplier interface, which returns the corresponding property name. These properties can be overwritten by the system environment using Eclipse Microprofile or Jakarta Config API.
See Also:
  • Settings
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Define the compartment name in Oracle Cloud Infrastructure.
    Define the path of configuration file used to load session token in Oracle NoSQL cloud.
    Specifies the deployment type for Oracle NoSQL database.
    Specifies the fingerprint for authentication with Oracle NoSQL database for Cloud deployment.
    Specifies the hostname or IP address of the Oracle NoSQL database server.
    Define the compartment name in Oracle NoSQL on-premise.
    Specifies the password used to authenticate with the Oracle NoSQL database.
    Specifies the private key for authentication with Oracle NoSQL database for Cloud deployment.
    Define the profile name used to load session token in Oracle NoSQL cloud.
    Specifies the amount of time to wait, in milliseconds, between polling attempts when creating a table.
    Specifies the desired throughput of read operations when creating a table using Eclipse JNoSQL.
    Specifies the maximum storage, in gigabytes, to be consumed by a table created using Eclipse JNoSQL.
    Specifies the total amount of time to wait, in milliseconds, when creating a table.
    Specifies the desired throughput of write operations when creating a table using Eclipse JNoSQL.
    Specifies the Oracle NoSQL database tenant ID for Cloud deployment.
    Specifies the username used to authenticate with the Oracle NoSQL database.
  • Method Summary

    Modifier and Type
    Method
    Description
    get()
     
    Returns the enum constant of this class with the specified name.
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • HOST

      public static final OracleNoSQLConfigurations HOST
      Specifies the hostname or IP address of the Oracle NoSQL database server. Default value: http://localhost:8080
    • USER

      public static final OracleNoSQLConfigurations USER
      Specifies the username used to authenticate with the Oracle NoSQL database.
    • PASSWORD

      public static final OracleNoSQLConfigurations PASSWORD
      Specifies the password used to authenticate with the Oracle NoSQL database.
    • TABLE_READ_LIMITS

      public static final OracleNoSQLConfigurations TABLE_READ_LIMITS
      Specifies the desired throughput of read operations when creating a table using Eclipse JNoSQL. A read unit represents 1 eventually consistent read per second for data up to 1 KB in size. Double the read units are consumed for absolutely consistent reads. Default value: 25
    • TABLE_WRITE_LIMITS

      public static final OracleNoSQLConfigurations TABLE_WRITE_LIMITS
      Specifies the desired throughput of write operations when creating a table using Eclipse JNoSQL. A write unit represents 1 write per second of data up to 1 KB in size. Default value: 25
    • TABLE_STORAGE_GB

      public static final OracleNoSQLConfigurations TABLE_STORAGE_GB
      Specifies the maximum storage, in gigabytes, to be consumed by a table created using Eclipse JNoSQL. Default value: 25
    • TABLE_WAIT_MILLIS

      public static final OracleNoSQLConfigurations TABLE_WAIT_MILLIS
      Specifies the total amount of time to wait, in milliseconds, when creating a table. This value must be non-zero and greater than the delayMillis.
    • TABLE_DELAY_MILLIS

      public static final OracleNoSQLConfigurations TABLE_DELAY_MILLIS
      Specifies the amount of time to wait, in milliseconds, between polling attempts when creating a table. If set to 0, it defaults to 500 milliseconds.
    • DEPLOYMENT

      public static final OracleNoSQLConfigurations DEPLOYMENT
      Specifies the deployment type for Oracle NoSQL database. Default value: DeploymentType.ON_PREMISES
    • TENANT

      public static final OracleNoSQLConfigurations TENANT
      Specifies the Oracle NoSQL database tenant ID for Cloud deployment. Relevant for Cloud deployment only.
    • FINGERPRINT

      public static final OracleNoSQLConfigurations FINGERPRINT
      Specifies the fingerprint for authentication with Oracle NoSQL database for Cloud deployment. Relevant for Cloud deployment only.
    • PRIVATE_KEY

      public static final OracleNoSQLConfigurations PRIVATE_KEY
      Specifies the private key for authentication with Oracle NoSQL database for Cloud deployment. Relevant for Cloud deployment only.
    • COMPARTMENT

      public static final OracleNoSQLConfigurations COMPARTMENT
      Define the compartment name in Oracle Cloud Infrastructure.
    • NAMESPACE

      public static final OracleNoSQLConfigurations NAMESPACE
      Define the compartment name in Oracle NoSQL on-premise.
    • PROFILE_NAME

      public static final OracleNoSQLConfigurations PROFILE_NAME
      Define the profile name used to load session token in Oracle NoSQL cloud.
    • CONFIG_FILE

      public static final OracleNoSQLConfigurations CONFIG_FILE
      Define the path of configuration file used to load session token in Oracle NoSQL cloud.
  • Method Details

    • values

      public static OracleNoSQLConfigurations[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static OracleNoSQLConfigurations valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null
    • get

      public String get()
      Specified by:
      get in interface Supplier<String>