DseDriverOption (Java driver for Scylla and Apache Cassandra(R)

java.lang.Object
- java.lang.Enum<DseDriverOption>
- - com.datastax.dse.driver.api.core.config.DseDriverOption

All Implemented Interfaces:: DriverOption, Serializable, Comparable<DseDriverOption>

public enum DseDriverOption
extends Enum<DseDriverOption>
implements DriverOption

Enum Constant Summary

Enum Constants
Enum Constant and Description
`APPLICATION_NAME` The name of the application using the session.
`APPLICATION_VERSION` The version of the application using the session.
`AUTH_PROVIDER_AUTHORIZATION_ID` Proxy authentication for GSSAPI authentication: allows to login as another user or role.
`AUTH_PROVIDER_LOGIN_CONFIGURATION` Login configuration for GSSAPI authentication.
`AUTH_PROVIDER_SASL_PROPERTIES` Internal SASL properties, if any, such as QOP, for GSSAPI authentication.
`AUTH_PROVIDER_SERVICE` Service name for GSSAPI authentication.
`CONTINUOUS_PAGING_MAX_ENQUEUED_PAGES` The maximum number of continuous pages that can be stored in the local queue.
`CONTINUOUS_PAGING_MAX_PAGES` The maximum number of continuous pages to return.
`CONTINUOUS_PAGING_MAX_PAGES_PER_SECOND` The maximum number of continuous pages per second.
`CONTINUOUS_PAGING_METRICS_SESSION_CQL_REQUESTS_DIGITS` The number of significant decimal digits to which internal structures will maintain for continuous requests.
`CONTINUOUS_PAGING_METRICS_SESSION_CQL_REQUESTS_HIGHEST` The largest latency that we expect to record for continuous requests.
`CONTINUOUS_PAGING_METRICS_SESSION_CQL_REQUESTS_INTERVAL` The interval at which percentile data is refreshed for continuous requests.
`CONTINUOUS_PAGING_METRICS_SESSION_CQL_REQUESTS_LOWEST` The shortest latency that we expect to record for continuous requests.
`CONTINUOUS_PAGING_METRICS_SESSION_CQL_REQUESTS_SLO` Optional service-level objectives to meet, as a list of latencies to track.
`CONTINUOUS_PAGING_PAGE_SIZE` The page size for continuous paging.
`CONTINUOUS_PAGING_PAGE_SIZE_BYTES` Whether `CONTINUOUS_PAGING_PAGE_SIZE` should be interpreted in number of rows or bytes.
`CONTINUOUS_PAGING_TIMEOUT_FIRST_PAGE` How long to wait for the coordinator to send the first continuous page.
`CONTINUOUS_PAGING_TIMEOUT_OTHER_PAGES` How long to wait for the coordinator to send subsequent continuous pages.
`GRAPH_CONTINUOUS_PAGING_MAX_ENQUEUED_PAGES` The maximum number of Graph continuous pages that can be stored in the local queue.
`GRAPH_CONTINUOUS_PAGING_MAX_PAGES` The maximum number of Graph continuous pages to return.
`GRAPH_CONTINUOUS_PAGING_MAX_PAGES_PER_SECOND` The maximum number of Graph continuous pages per second.
`GRAPH_CONTINUOUS_PAGING_PAGE_SIZE` The page size for Graph continuous paging.
`GRAPH_IS_SYSTEM_QUERY` Whether a script statement represents a system query.
`GRAPH_NAME` The name of the graph targeted by graph statements.
`GRAPH_PAGING_ENABLED` Whether to enable paging for Graph queries.
`GRAPH_READ_CONSISTENCY_LEVEL` The read consistency level to use for graph statements.
`GRAPH_SUB_PROTOCOL` The sub-protocol the driver will use to communicate with DSE Graph, on top of the Cassandra native protocol.
`GRAPH_TIMEOUT` How long the driver waits for a graph request to complete.
`GRAPH_TRAVERSAL_SOURCE` The traversal source to use for graph statements.
`GRAPH_WRITE_CONSISTENCY_LEVEL` The write consistency level to use for graph statements.
`METRICS_NODE_GRAPH_MESSAGES_DIGITS` The number of significant decimal digits to which internal structures will maintain for graph requests.
`METRICS_NODE_GRAPH_MESSAGES_HIGHEST` The largest latency that we expect to record for graph requests.
`METRICS_NODE_GRAPH_MESSAGES_INTERVAL` The interval at which percentile data is refreshed for graph requests.
`METRICS_NODE_GRAPH_MESSAGES_LOWEST` The shortest latency that we expect to record for graph requests.
`METRICS_NODE_GRAPH_MESSAGES_SLO` Optional service-level objectives to meet, as a list of latencies to track.
`METRICS_SESSION_GRAPH_REQUESTS_DIGITS` The number of significant decimal digits to which internal structures will maintain for graph requests.
`METRICS_SESSION_GRAPH_REQUESTS_HIGHEST` The largest latency that we expect to record for graph requests.
`METRICS_SESSION_GRAPH_REQUESTS_INTERVAL` The interval at which percentile data is refreshed for graph requests.
`METRICS_SESSION_GRAPH_REQUESTS_LOWEST` The shortest latency that we expect to record for graph requests.
`METRICS_SESSION_GRAPH_REQUESTS_SLO` Optional service-level objectives to meet, as a list of latencies to track.
`MONITOR_REPORTING_ENABLED` Whether to send events for Insights monitoring.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getPath()` The option's path.
`static DseDriverOption`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static DseDriverOption[]`	`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
  - APPLICATION_NAME
```
public static final DseDriverOption APPLICATION_NAME
```
    The name of the application using the session.
    Value type: String
  - APPLICATION_VERSION
```
public static final DseDriverOption APPLICATION_VERSION
```
    The version of the application using the session.
    Value type: String
  - AUTH_PROVIDER_AUTHORIZATION_ID
```
public static final DseDriverOption AUTH_PROVIDER_AUTHORIZATION_ID
```
    Proxy authentication for GSSAPI authentication: allows to login as another user or role.
    Value type: String
  - AUTH_PROVIDER_SERVICE
```
public static final DseDriverOption AUTH_PROVIDER_SERVICE
```
    Service name for GSSAPI authentication.
    Value type: String
  - AUTH_PROVIDER_LOGIN_CONFIGURATION
```
public static final DseDriverOption AUTH_PROVIDER_LOGIN_CONFIGURATION
```
    Login configuration for GSSAPI authentication.
    Value type: Map<String,String>
  - AUTH_PROVIDER_SASL_PROPERTIES
```
public static final DseDriverOption AUTH_PROVIDER_SASL_PROPERTIES
```
    Internal SASL properties, if any, such as QOP, for GSSAPI authentication.
    Value type: Map<String,String>
  - CONTINUOUS_PAGING_PAGE_SIZE
```
public static final DseDriverOption CONTINUOUS_PAGING_PAGE_SIZE
```
    The page size for continuous paging.
    Value type: int
  - CONTINUOUS_PAGING_PAGE_SIZE_BYTES
```
public static final DseDriverOption CONTINUOUS_PAGING_PAGE_SIZE_BYTES
```
    Whether CONTINUOUS_PAGING_PAGE_SIZE should be interpreted in number of rows or bytes.
    Value type: boolean
  - CONTINUOUS_PAGING_MAX_PAGES
```
public static final DseDriverOption CONTINUOUS_PAGING_MAX_PAGES
```
    The maximum number of continuous pages to return.
    Value type: int
  - CONTINUOUS_PAGING_MAX_PAGES_PER_SECOND
```
public static final DseDriverOption CONTINUOUS_PAGING_MAX_PAGES_PER_SECOND
```
    The maximum number of continuous pages per second.
    Value type: int
  - CONTINUOUS_PAGING_MAX_ENQUEUED_PAGES
```
public static final DseDriverOption CONTINUOUS_PAGING_MAX_ENQUEUED_PAGES
```
    The maximum number of continuous pages that can be stored in the local queue.
    Value type: int
  - CONTINUOUS_PAGING_TIMEOUT_FIRST_PAGE
```
public static final DseDriverOption CONTINUOUS_PAGING_TIMEOUT_FIRST_PAGE
```
    How long to wait for the coordinator to send the first continuous page.
    Value-type: Duration
  - CONTINUOUS_PAGING_TIMEOUT_OTHER_PAGES
```
public static final DseDriverOption CONTINUOUS_PAGING_TIMEOUT_OTHER_PAGES
```
    How long to wait for the coordinator to send subsequent continuous pages.
    Value-type: Duration
  - CONTINUOUS_PAGING_METRICS_SESSION_CQL_REQUESTS_HIGHEST
```
public static final DseDriverOption CONTINUOUS_PAGING_METRICS_SESSION_CQL_REQUESTS_HIGHEST
```
    The largest latency that we expect to record for continuous requests.
    Value-type: Duration
  - CONTINUOUS_PAGING_METRICS_SESSION_CQL_REQUESTS_DIGITS
```
public static final DseDriverOption CONTINUOUS_PAGING_METRICS_SESSION_CQL_REQUESTS_DIGITS
```
    The number of significant decimal digits to which internal structures will maintain for continuous requests.
    Value-type: int
  - CONTINUOUS_PAGING_METRICS_SESSION_CQL_REQUESTS_INTERVAL
```
public static final DseDriverOption CONTINUOUS_PAGING_METRICS_SESSION_CQL_REQUESTS_INTERVAL
```
    The interval at which percentile data is refreshed for continuous requests.
    Value-type: Duration
  - GRAPH_READ_CONSISTENCY_LEVEL
```
public static final DseDriverOption GRAPH_READ_CONSISTENCY_LEVEL
```
    The read consistency level to use for graph statements.
    Value type: String
  - GRAPH_WRITE_CONSISTENCY_LEVEL
```
public static final DseDriverOption GRAPH_WRITE_CONSISTENCY_LEVEL
```
    The write consistency level to use for graph statements.
    Value type: String
  - GRAPH_TRAVERSAL_SOURCE
```
public static final DseDriverOption GRAPH_TRAVERSAL_SOURCE
```
    The traversal source to use for graph statements.
    Value type: String
  - GRAPH_SUB_PROTOCOL
```
public static final DseDriverOption GRAPH_SUB_PROTOCOL
```
    The sub-protocol the driver will use to communicate with DSE Graph, on top of the Cassandra native protocol.
    Value type: String
  - GRAPH_IS_SYSTEM_QUERY
```
public static final DseDriverOption GRAPH_IS_SYSTEM_QUERY
```
    Whether a script statement represents a system query.
    Value type: boolean
  - GRAPH_NAME
```
public static final DseDriverOption GRAPH_NAME
```
    The name of the graph targeted by graph statements.
    Value type: String
  - GRAPH_TIMEOUT
```
public static final DseDriverOption GRAPH_TIMEOUT
```
    How long the driver waits for a graph request to complete.
    Value-type: Duration
  - MONITOR_REPORTING_ENABLED
```
public static final DseDriverOption MONITOR_REPORTING_ENABLED
```
    Whether to send events for Insights monitoring.
    Value type: boolean
  - GRAPH_PAGING_ENABLED
```
public static final DseDriverOption GRAPH_PAGING_ENABLED
```
    Whether to enable paging for Graph queries.
    Value type: String
  - GRAPH_CONTINUOUS_PAGING_PAGE_SIZE
```
public static final DseDriverOption GRAPH_CONTINUOUS_PAGING_PAGE_SIZE
```
    The page size for Graph continuous paging.
    Value type: int
  - GRAPH_CONTINUOUS_PAGING_MAX_PAGES
```
public static final DseDriverOption GRAPH_CONTINUOUS_PAGING_MAX_PAGES
```
    The maximum number of Graph continuous pages to return.
    Value type: int
  - GRAPH_CONTINUOUS_PAGING_MAX_PAGES_PER_SECOND
```
public static final DseDriverOption GRAPH_CONTINUOUS_PAGING_MAX_PAGES_PER_SECOND
```
    The maximum number of Graph continuous pages per second.
    Value type: int
  - GRAPH_CONTINUOUS_PAGING_MAX_ENQUEUED_PAGES
```
public static final DseDriverOption GRAPH_CONTINUOUS_PAGING_MAX_ENQUEUED_PAGES
```
    The maximum number of Graph continuous pages that can be stored in the local queue.
    Value type: int
  - METRICS_SESSION_GRAPH_REQUESTS_HIGHEST
```
public static final DseDriverOption METRICS_SESSION_GRAPH_REQUESTS_HIGHEST
```
    The largest latency that we expect to record for graph requests.
    Value-type: Duration
  - METRICS_SESSION_GRAPH_REQUESTS_DIGITS
```
public static final DseDriverOption METRICS_SESSION_GRAPH_REQUESTS_DIGITS
```
    The number of significant decimal digits to which internal structures will maintain for graph requests.
    Value-type: int
  - METRICS_SESSION_GRAPH_REQUESTS_INTERVAL
```
public static final DseDriverOption METRICS_SESSION_GRAPH_REQUESTS_INTERVAL
```
    The interval at which percentile data is refreshed for graph requests.
    Value-type: Duration
  - METRICS_NODE_GRAPH_MESSAGES_HIGHEST
```
public static final DseDriverOption METRICS_NODE_GRAPH_MESSAGES_HIGHEST
```
    The largest latency that we expect to record for graph requests.
    Value-type: Duration
  - METRICS_NODE_GRAPH_MESSAGES_DIGITS
```
public static final DseDriverOption METRICS_NODE_GRAPH_MESSAGES_DIGITS
```
    The number of significant decimal digits to which internal structures will maintain for graph requests.
    Value-type: int
  - METRICS_NODE_GRAPH_MESSAGES_INTERVAL
```
public static final DseDriverOption METRICS_NODE_GRAPH_MESSAGES_INTERVAL
```
    The interval at which percentile data is refreshed for graph requests.
    Value-type: Duration
  - CONTINUOUS_PAGING_METRICS_SESSION_CQL_REQUESTS_LOWEST
```
public static final DseDriverOption CONTINUOUS_PAGING_METRICS_SESSION_CQL_REQUESTS_LOWEST
```
    The shortest latency that we expect to record for continuous requests.
    Value-type: Duration
  - CONTINUOUS_PAGING_METRICS_SESSION_CQL_REQUESTS_SLO
```
public static final DseDriverOption CONTINUOUS_PAGING_METRICS_SESSION_CQL_REQUESTS_SLO
```
    Optional service-level objectives to meet, as a list of latencies to track.
    Value-type: Duration
  - METRICS_SESSION_GRAPH_REQUESTS_LOWEST
```
public static final DseDriverOption METRICS_SESSION_GRAPH_REQUESTS_LOWEST
```
    The shortest latency that we expect to record for graph requests.
    Value-type: Duration
  - METRICS_SESSION_GRAPH_REQUESTS_SLO
```
public static final DseDriverOption METRICS_SESSION_GRAPH_REQUESTS_SLO
```
    Optional service-level objectives to meet, as a list of latencies to track.
    Value-type: Duration
  - METRICS_NODE_GRAPH_MESSAGES_LOWEST
```
public static final DseDriverOption METRICS_NODE_GRAPH_MESSAGES_LOWEST
```
    The shortest latency that we expect to record for graph requests.
    Value-type: Duration
  - METRICS_NODE_GRAPH_MESSAGES_SLO
```
public static final DseDriverOption METRICS_NODE_GRAPH_MESSAGES_SLO
```
    Optional service-level objectives to meet, as a list of latencies to track.
    Value-type: Duration
- Method Detail
  - values
```
public static DseDriverOption[] 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 (DseDriverOption c : DseDriverOption.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DseDriverOption 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
  - getPath
```
@NonNull
public String getPath()
```
    Description copied from interface: DriverOption
    
    The option's path. Paths are hierarchical and each segment is separated by a dot, e.g. metadata.schema.enabled.
    
    Specified by:
    
    getPath in interface DriverOption

Enum DseDriverOption

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

APPLICATION_NAME

APPLICATION_VERSION

AUTH_PROVIDER_AUTHORIZATION_ID

AUTH_PROVIDER_SERVICE

AUTH_PROVIDER_LOGIN_CONFIGURATION

AUTH_PROVIDER_SASL_PROPERTIES

CONTINUOUS_PAGING_PAGE_SIZE

CONTINUOUS_PAGING_PAGE_SIZE_BYTES

CONTINUOUS_PAGING_MAX_PAGES

CONTINUOUS_PAGING_MAX_PAGES_PER_SECOND

CONTINUOUS_PAGING_MAX_ENQUEUED_PAGES

CONTINUOUS_PAGING_TIMEOUT_FIRST_PAGE

CONTINUOUS_PAGING_TIMEOUT_OTHER_PAGES

CONTINUOUS_PAGING_METRICS_SESSION_CQL_REQUESTS_HIGHEST

CONTINUOUS_PAGING_METRICS_SESSION_CQL_REQUESTS_DIGITS

CONTINUOUS_PAGING_METRICS_SESSION_CQL_REQUESTS_INTERVAL

GRAPH_READ_CONSISTENCY_LEVEL

GRAPH_WRITE_CONSISTENCY_LEVEL

GRAPH_TRAVERSAL_SOURCE

GRAPH_SUB_PROTOCOL

GRAPH_IS_SYSTEM_QUERY

GRAPH_NAME

GRAPH_TIMEOUT

MONITOR_REPORTING_ENABLED

GRAPH_PAGING_ENABLED

GRAPH_CONTINUOUS_PAGING_PAGE_SIZE

GRAPH_CONTINUOUS_PAGING_MAX_PAGES

GRAPH_CONTINUOUS_PAGING_MAX_PAGES_PER_SECOND

GRAPH_CONTINUOUS_PAGING_MAX_ENQUEUED_PAGES

METRICS_SESSION_GRAPH_REQUESTS_HIGHEST

METRICS_SESSION_GRAPH_REQUESTS_DIGITS

METRICS_SESSION_GRAPH_REQUESTS_INTERVAL

METRICS_NODE_GRAPH_MESSAGES_HIGHEST

METRICS_NODE_GRAPH_MESSAGES_DIGITS

METRICS_NODE_GRAPH_MESSAGES_INTERVAL

CONTINUOUS_PAGING_METRICS_SESSION_CQL_REQUESTS_LOWEST

CONTINUOUS_PAGING_METRICS_SESSION_CQL_REQUESTS_SLO

METRICS_SESSION_GRAPH_REQUESTS_LOWEST

METRICS_SESSION_GRAPH_REQUESTS_SLO

METRICS_NODE_GRAPH_MESSAGES_LOWEST

METRICS_NODE_GRAPH_MESSAGES_SLO

Method Detail

values

valueOf

getPath