com.datastax.oss.driver.api.core.config

Interface DriverExecutionProfile

All Superinterfaces:

OngoingConfigOptions<DriverExecutionProfile>

public interface DriverExecutionProfile
extends OngoingConfigOptions<DriverExecutionProfile>

A profile in the driver's configuration.

It is a collection of typed options.

Getters (such as getBoolean(DriverOption)) are self-explanatory.

withXxx methods (such as withBoolean(DriverOption, boolean)) create a "derived" profile, which is an on-the-fly copy of the profile with the new value (which might be a new option, or overwrite an existing one). If the original configuration is reloaded, all derived profiles get updated as well. For best performance, such derived profiles should be used sparingly; it is better to have built-in profiles for common scenarios.

See Also:

DriverConfig

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_NAME The name of the default profile (the string "default").

Method Summary

Modifier and Type	Method and Description
SortedSet<Map.Entry<String,Object>>	entrySet() Enumerates all the entries in this profile, including those that were inherited from another profile.
boolean	getBoolean(DriverOption option)
default boolean	getBoolean(DriverOption option, boolean defaultValue)
List<Boolean>	getBooleanList(DriverOption option)
default List<Boolean>	getBooleanList(DriverOption option, List<Boolean> defaultValue)
long	getBytes(DriverOption option)
default long	getBytes(DriverOption option, long defaultValue)
List<Long>	getBytesList(DriverOption option)
default List<Long>	getBytesList(DriverOption option, List<Long> defaultValue)
default Object	getComparisonKey(DriverOption option) Returns a representation of all the child options under a given option.
double	getDouble(DriverOption option)
default double	getDouble(DriverOption option, double defaultValue)
List<Double>	getDoubleList(DriverOption option)
default List<Double>	getDoubleList(DriverOption option, List<Double> defaultValue)
Duration	getDuration(DriverOption option)
default Duration	getDuration(DriverOption option, Duration defaultValue)
List<Duration>	getDurationList(DriverOption option)
default List<Duration>	getDurationList(DriverOption option, List<Duration> defaultValue)
int	getInt(DriverOption option)
default int	getInt(DriverOption option, int defaultValue)
List<Integer>	getIntList(DriverOption option)
default List<Integer>	getIntList(DriverOption option, List<Integer> defaultValue)
long	getLong(DriverOption option)
default long	getLong(DriverOption option, long defaultValue)
List<Long>	getLongList(DriverOption option)
default List<Long>	getLongList(DriverOption option, List<Long> defaultValue)
String	getName() The name of the profile in the configuration.
String	getString(DriverOption option)
default String	getString(DriverOption option, String defaultValue)
List<String>	getStringList(DriverOption option)
default List<String>	getStringList(DriverOption option, List<String> defaultValue)
Map<String,String>	getStringMap(DriverOption option)
default Map<String,String>	getStringMap(DriverOption option, Map<String,String> defaultValue)
boolean	isDefined(DriverOption option)
default DriverExecutionProfile	withBoolean(DriverOption option, boolean value)
default DriverExecutionProfile	withBooleanList(DriverOption option, List<Boolean> value)
default DriverExecutionProfile	withBytes(DriverOption option, long value)
default DriverExecutionProfile	withBytesList(DriverOption option, List<Long> value)
default DriverExecutionProfile	withDouble(DriverOption option, double value)
default DriverExecutionProfile	withDoubleList(DriverOption option, List<Double> value)
default DriverExecutionProfile	withDuration(DriverOption option, Duration value)
default DriverExecutionProfile	withDurationList(DriverOption option, List<Duration> value)
default DriverExecutionProfile	withInt(DriverOption option, int value)
default DriverExecutionProfile	withIntList(DriverOption option, List<Integer> value)
default DriverExecutionProfile	withLong(DriverOption option, long value)
default DriverExecutionProfile	withLongList(DriverOption option, List<Long> value)
default DriverExecutionProfile	without(DriverOption option)
default DriverExecutionProfile	withString(DriverOption option, String value)
default DriverExecutionProfile	withStringList(DriverOption option, List<String> value)
default DriverExecutionProfile	withStringMap(DriverOption option, Map<String,String> value)

Methods inherited from interface com.datastax.oss.driver.api.core.config.OngoingConfigOptions

withClass, withClassList

Field Detail

DEFAULT_NAME

static final String DEFAULT_NAME

The name of the default profile (the string "default").

Named profiles can't use this name. If you try to declare such a profile, a runtime error will be thrown.

See Also:

Constant Field Values

Method Detail

getName

@NonNull
String getName()

The name of the profile in the configuration.

Derived profiles inherit the name of their parent.

isDefined

boolean isDefined(@NonNull
                  DriverOption option)

getBoolean

boolean getBoolean(@NonNull
                   DriverOption option)

getBoolean

default boolean getBoolean(@NonNull
                           DriverOption option,
                           boolean defaultValue)

getBooleanList

@NonNull
List<Boolean> getBooleanList(@NonNull
                                      DriverOption option)

getBooleanList

@Nullable
default List<Boolean> getBooleanList(@NonNull
                                               DriverOption option,
                                               @Nullable
                                               List<Boolean> defaultValue)

getInt

int getInt(@NonNull
           DriverOption option)

getInt

default int getInt(@NonNull
                   DriverOption option,
                   int defaultValue)

getIntList

@NonNull
List<Integer> getIntList(@NonNull
                                  DriverOption option)

getIntList

@Nullable
default List<Integer> getIntList(@NonNull
                                           DriverOption option,
                                           @Nullable
                                           List<Integer> defaultValue)

getLong

long getLong(@NonNull
             DriverOption option)

getLong

default long getLong(@NonNull
                     DriverOption option,
                     long defaultValue)

getLongList

@NonNull
List<Long> getLongList(@NonNull
                                DriverOption option)

getLongList

@Nullable
default List<Long> getLongList(@NonNull
                                         DriverOption option,
                                         @Nullable
                                         List<Long> defaultValue)

getDouble

double getDouble(@NonNull
                 DriverOption option)

getDouble

default double getDouble(@NonNull
                         DriverOption option,
                         double defaultValue)

getDoubleList

@NonNull
List<Double> getDoubleList(@NonNull
                                    DriverOption option)

getDoubleList

@Nullable
default List<Double> getDoubleList(@NonNull
                                             DriverOption option,
                                             @Nullable
                                             List<Double> defaultValue)

getString

@NonNull
String getString(@NonNull
                          DriverOption option)

getString

@Nullable
default String getString(@NonNull
                                   DriverOption option,
                                   @Nullable
                                   String defaultValue)

getStringList

@NonNull
List<String> getStringList(@NonNull
                                    DriverOption option)

getStringList

@Nullable
default List<String> getStringList(@NonNull
                                             DriverOption option,
                                             @Nullable
                                             List<String> defaultValue)

getStringMap

@NonNull
Map<String,String> getStringMap(@NonNull
                                         DriverOption option)

getStringMap

@Nullable
default Map<String,String> getStringMap(@NonNull
                                                  DriverOption option,
                                                  @Nullable
                                                  Map<String,String> defaultValue)

getBytes

long getBytes(@NonNull
              DriverOption option)

Returns:

a size in bytes. This is separate from getLong(DriverOption), in case implementations want to allow users to provide sizes in a more human-readable way, for example "256 MB".

getBytes

default long getBytes(@NonNull
                      DriverOption option,
                      long defaultValue)

getBytesList

@NonNull
List<Long> getBytesList(DriverOption option)

See Also:

getBytes(DriverOption)

getBytesList

@Nullable
default List<Long> getBytesList(DriverOption option,
                                          @Nullable
                                          List<Long> defaultValue)

getDuration

@NonNull
Duration getDuration(@NonNull
                              DriverOption option)

getDuration

@Nullable
default Duration getDuration(@NonNull
                                       DriverOption option,
                                       @Nullable
                                       Duration defaultValue)

getDurationList

@NonNull
List<Duration> getDurationList(@NonNull
                                        DriverOption option)

getDurationList

@Nullable
default List<Duration> getDurationList(@NonNull
                                                 DriverOption option,
                                                 @Nullable
                                                 List<Duration> defaultValue)

getComparisonKey

@NonNull
default Object getComparisonKey(@NonNull
                                         DriverOption option)

Returns a representation of all the child options under a given option.

This is used by the driver at initialization time, to compare profiles and determine if it must create per-profile policies. For example, if two profiles have the same options in the basic.load-balancing-policy section, they will share the same policy instance. But if their options differ, two separate instances will be created.

The runtime return type does not matter, as long as identical sections (same options with same values, regardless of order) compare as equal and have the same hashCode(). The default implementation builds a map based on the entries from entrySet(), it should be good for most cases.

entrySet

@NonNull
SortedSet<Map.Entry<String,Object>> entrySet()

Enumerates all the entries in this profile, including those that were inherited from another profile.

The keys are raw strings that match DriverOption.getPath().

The values are implementation-dependent. With the driver's default implementation, the possible types are String, Number, Boolean, Map<String,Object>, List<Object>, or null.

withBoolean

@NonNull
default DriverExecutionProfile withBoolean(@NonNull
                                                    DriverOption option,
                                                    boolean value)

Specified by:

withBoolean in interface OngoingConfigOptions<DriverExecutionProfile>

withBooleanList

@NonNull
default DriverExecutionProfile withBooleanList(@NonNull
                                                        DriverOption option,
                                                        @NonNull
                                                        List<Boolean> value)

Specified by:

withBooleanList in interface OngoingConfigOptions<DriverExecutionProfile>

withInt

@NonNull
default DriverExecutionProfile withInt(@NonNull
                                                DriverOption option,
                                                int value)

Specified by:

withInt in interface OngoingConfigOptions<DriverExecutionProfile>

withIntList

@NonNull
default DriverExecutionProfile withIntList(@NonNull
                                                    DriverOption option,
                                                    @NonNull
                                                    List<Integer> value)

Specified by:

withIntList in interface OngoingConfigOptions<DriverExecutionProfile>

withLong

@NonNull
default DriverExecutionProfile withLong(@NonNull
                                                 DriverOption option,
                                                 long value)

Specified by:

withLong in interface OngoingConfigOptions<DriverExecutionProfile>

withLongList

@NonNull
default DriverExecutionProfile withLongList(@NonNull
                                                     DriverOption option,
                                                     @NonNull
                                                     List<Long> value)

Specified by:

withLongList in interface OngoingConfigOptions<DriverExecutionProfile>

withDouble

@NonNull
default DriverExecutionProfile withDouble(@NonNull
                                                   DriverOption option,
                                                   double value)

Specified by:

withDouble in interface OngoingConfigOptions<DriverExecutionProfile>

withDoubleList

@NonNull
default DriverExecutionProfile withDoubleList(@NonNull
                                                       DriverOption option,
                                                       @NonNull
                                                       List<Double> value)

Specified by:

withDoubleList in interface OngoingConfigOptions<DriverExecutionProfile>

withString

@NonNull
default DriverExecutionProfile withString(@NonNull
                                                   DriverOption option,
                                                   @NonNull
                                                   String value)

Specified by:

withString in interface OngoingConfigOptions<DriverExecutionProfile>

withStringList

@NonNull
default DriverExecutionProfile withStringList(@NonNull
                                                       DriverOption option,
                                                       @NonNull
                                                       List<String> value)

Specified by:

withStringList in interface OngoingConfigOptions<DriverExecutionProfile>

withStringMap

@NonNull
default DriverExecutionProfile withStringMap(@NonNull
                                                      DriverOption option,
                                                      @NonNull
                                                      Map<String,String> value)

Specified by:

withStringMap in interface OngoingConfigOptions<DriverExecutionProfile>

withBytes

@NonNull
default DriverExecutionProfile withBytes(@NonNull
                                                  DriverOption option,
                                                  long value)

Specified by:

withBytes in interface OngoingConfigOptions<DriverExecutionProfile>

withBytesList

@NonNull
default DriverExecutionProfile withBytesList(@NonNull
                                                      DriverOption option,
                                                      @NonNull
                                                      List<Long> value)

Specified by:

withBytesList in interface OngoingConfigOptions<DriverExecutionProfile>

withDuration

@NonNull
default DriverExecutionProfile withDuration(@NonNull
                                                     DriverOption option,
                                                     @NonNull
                                                     Duration value)

Specified by:

withDuration in interface OngoingConfigOptions<DriverExecutionProfile>

withDurationList

@NonNull
default DriverExecutionProfile withDurationList(@NonNull
                                                         DriverOption option,
                                                         @NonNull
                                                         List<Duration> value)

Specified by:

withDurationList in interface OngoingConfigOptions<DriverExecutionProfile>

without

@NonNull
default DriverExecutionProfile without(@NonNull
                                                DriverOption option)

Specified by:

without in interface OngoingConfigOptions<DriverExecutionProfile>