io.split.client

Class SplitClientConfig.Builder

java.lang.Object

io.split.client.SplitClientConfig.Builder

Enclosing class:

SplitClientConfig

public static final class SplitClientConfig.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SplitClientConfig	build()
SplitClientConfig.Builder	connectionTimeoutInMs(int ms) Http client connection timeout.
SplitClientConfig.Builder	enableDebug()
SplitClientConfig.Builder	endpoint(String endpoint) The rest endpoint that sdk will hit for latest features and segments.
SplitClientConfig.Builder	numThreadsForSegmentFetch(int numThreads) The SDK fetches segment memberships on a schedule in an asynchrnonous manner.
SplitClientConfig.Builder	pollForFeatureChangesEveryNSeconds(int n) The SDK will poll the endpoint for changes to features at this period.
SplitClientConfig.Builder	pollForSegmentChangesEveryNSeconds(int n) The SDK will poll the endpoint for changes to segments at this period in seconds.
SplitClientConfig.Builder	readTimeoutInMs(int ms) Http client read timeout.
SplitClientConfig.Builder	treatmentLogCacheExpireNSecondsAfterWrite(int n) The treatment log captures the which key saw what treatment ("on", "off", etc) at what time.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

endpoint

public SplitClientConfig.Builder endpoint(String endpoint)

The rest endpoint that sdk will hit for latest features and segments.

Parameters:

endpoint - MUST NOT be null

Returns:

pollForFeatureChangesEveryNSeconds

public SplitClientConfig.Builder pollForFeatureChangesEveryNSeconds(int n)

The SDK will poll the endpoint for changes to features at this period.

Implementation Note: The SDK actually polls at a random interval chosen between (0.5 * n, n). This is to ensure that SDKs that are deployed simultaneously on different machines do not inundate the backend with requests at the same interval.

Parameters:

n - MUST be greater than 0. Default value is 60.

Returns:

pollForSegmentChangesEveryNSeconds

public SplitClientConfig.Builder pollForSegmentChangesEveryNSeconds(int n)

The SDK will poll the endpoint for changes to segments at this period in seconds.

Implementation Note: The SDK actually polls at a random interval chosen between (0.5 * n, n). This is to ensure that SDKs that are deployed simultaneously on different machines do not inundate the backend with requests at the same interval.

Parameters:

n - MUST be greater than 0. Default value is 60.

Returns:

treatmentLogCacheExpireNSecondsAfterWrite

public SplitClientConfig.Builder treatmentLogCacheExpireNSecondsAfterWrite(int n)

The treatment log captures the which key saw what treatment ("on", "off", etc) at what time. This log is periodically pushed back to split endpoint. This parameter controls how quickly does the cache expire after a write. This is an ADVANCED parameter

Parameters:

n - MUST be > 0.

Returns:

connectionTimeoutInMs

public SplitClientConfig.Builder connectionTimeoutInMs(int ms)

Http client connection timeout. Default value is 15000ms.

Parameters:

ms - MUST be greater than 0.

Returns:

readTimeoutInMs

public SplitClientConfig.Builder readTimeoutInMs(int ms)

Http client read timeout. Default value is 15000ms.

Parameters:

ms - MUST be greater than 0.

Returns:

enableDebug

public SplitClientConfig.Builder enableDebug()

numThreadsForSegmentFetch

public SplitClientConfig.Builder numThreadsForSegmentFetch(int numThreads)

The SDK fetches segment memberships on a schedule in an asynchrnonous manner. This parameter controls the number of threads in that thread pool.

Parameters:

numThreads - MUST BE greater than 0;

Returns:

build

public SplitClientConfig build()