Package glide.api.models.configuration

Class GlideClientConfiguration

java.lang.Object

glide.api.models.configuration.BaseClientConfiguration

glide.api.models.configuration.GlideClientConfiguration

public class GlideClientConfiguration
extends BaseClientConfiguration

Represents the configuration settings for a Standalone GlideClient.

Example:

 GlideClientConfiguration glideClientConfiguration =
     GlideClientConfiguration.builder()
         .address(node1address)
         .address(node2address)
         .useTLS(true)
         .readFrom(ReadFrom.PREFER_REPLICA)
         .credentials(credentialsConfiguration)
         .requestTimeout(2000)
         .reconnectStrategy(reconnectionConfiguration)
         .databaseId(1)
         .clientName("GLIDE")
         .subscriptionConfiguration(subscriptionConfiguration)
         .inflightRequestsLimit(1000)
         .clientSideCache(ClientSideCache.create(1024, 60000))
         .advancedConfiguration(AdvancedGlideClientConfiguration.builder().connectionTimeout(500).build())
         .readOnly(true)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GlideClientConfiguration.GlideClientConfigurationBuilder<C extends GlideClientConfiguration,B extends GlideClientConfiguration.GlideClientConfigurationBuilder<C,B>>

Nested classes/interfaces inherited from class glide.api.models.configuration.BaseClientConfiguration

BaseClientConfiguration.BaseClientConfigurationBuilder<C extends BaseClientConfiguration,B extends BaseClientConfiguration.BaseClientConfigurationBuilder<C,B>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GlideClientConfiguration(GlideClientConfiguration.GlideClientConfigurationBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static GlideClientConfiguration.GlideClientConfigurationBuilder<?,?>	builder()
AdvancedGlideClientConfiguration	getAdvancedConfiguration()	Advanced configuration settings for the client.
ClientSideCache	getClientSideCache()	Client-side cache configuration.
NodeDiscoveryMode	getNodeDiscoveryMode()	Controls how the client discovers node roles and topology in standalone mode.
StandaloneSubscriptionConfiguration	getSubscriptionConfiguration()	Subscription configuration for the current client.
boolean	isReadOnly()	When true, enables read-only mode for the standalone client.
java.lang.String	toString()

Methods inherited from class glide.api.models.configuration.BaseClientConfiguration

getAddresses, getAddressResolver, getClientAZ, getClientCircuitBreakerConfiguration, getClientName, getCompressionConfiguration, getCredentials, getDatabaseId, getInflightRequestsLimit, getLibName, getProtocol, getReadFrom, getReconnectStrategy, getRequestTimeout, isLazyConnect, isUseTLS

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GlideClientConfiguration

protected GlideClientConfiguration(GlideClientConfiguration.GlideClientConfigurationBuilder<?,?> b)

Method Detail

builder

public static GlideClientConfiguration.GlideClientConfigurationBuilder<?,?> builder()

getClientSideCache

public ClientSideCache getClientSideCache()

Client-side cache configuration. If provided, enables caching for this client.

Specified by:

getClientSideCache in class BaseClientConfiguration

getSubscriptionConfiguration

public StandaloneSubscriptionConfiguration getSubscriptionConfiguration()

Subscription configuration for the current client.

Specified by:

getSubscriptionConfiguration in class BaseClientConfiguration

getAdvancedConfiguration

public AdvancedGlideClientConfiguration getAdvancedConfiguration()

Advanced configuration settings for the client.

Specified by:

getAdvancedConfiguration in class BaseClientConfiguration

isReadOnly

public boolean isReadOnly()

When true, enables read-only mode for the standalone client. In read-only mode:

• The client skips primary node detection (INFO REPLICATION command)
• All connected nodes are treated as valid read targets
• Write commands are blocked and will return an error
• The default ReadFrom strategy becomes PREFER_REPLICA if not explicitly set

This is useful for connecting to replica-only deployments or when you want to prevent accidental write operations.

Note: read-only mode is not compatible with AZ_AFFINITY or AZ_AFFINITY_REPLICAS_AND_PRIMARY read strategies.

Defaults to false.

getNodeDiscoveryMode

public NodeDiscoveryMode getNodeDiscoveryMode()

Controls how the client discovers node roles and topology in standalone mode. Defaults to NodeDiscoveryMode.STANDARD.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object