Package com.azure.cosmos

Class CosmosContainerProactiveInitConfigBuilder

java.lang.Object

com.azure.cosmos.CosmosContainerProactiveInitConfigBuilder

public final class CosmosContainerProactiveInitConfigBuilder
extends Object

A builder to build CosmosContainerProactiveInitConfig

Constructor Summary

Constructors

Constructor	Description
CosmosContainerProactiveInitConfigBuilder(List<CosmosContainerIdentity> cosmosContainerIdentities)	Instantiates CosmosContainerProactiveInitConfigBuilder

Method Summary

Modifier and Type	Method	Description
CosmosContainerProactiveInitConfig	build()	Builds CosmosContainerProactiveInitConfig with the provided properties
CosmosContainerProactiveInitConfigBuilder	setAggressiveWarmupDuration(Duration aggressiveWarmupDuration)	Sets the time window represented as a Duration within which connections will be opened aggressively and in a blocking manner and outside which connections will be opened defensively and in a non-blocking manner
CosmosContainerProactiveInitConfigBuilder	setProactiveConnectionRegionsCount(int numProactiveConnectionRegions)	Sets the no. of regions to proactively connect to.

Methods inherited from class java.lang.Object

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

Constructor Details

CosmosContainerProactiveInitConfigBuilder

public CosmosContainerProactiveInitConfigBuilder(List<CosmosContainerIdentity> cosmosContainerIdentities)

Instantiates CosmosContainerProactiveInitConfigBuilder

Parameters:

cosmosContainerIdentities - the container identities - this parameter must be non-empty

Method Details

setProactiveConnectionRegionsCount

public CosmosContainerProactiveInitConfigBuilder setProactiveConnectionRegionsCount(int numProactiveConnectionRegions)

Sets the no. of regions to proactively connect to.

The no of proactive regions to connect to belong to the preferred list of regions
In order to minimize latencies associated with warming up caches and opening connections the no. of proactive connection regions cannot be more than MAX_NO_OF_PROACTIVE_CONNECTION_REGIONS.

Parameters:

numProactiveConnectionRegions - the no of proactive connection regions

Returns:

Current CosmosContainerProactiveInitConfigBuilder

setAggressiveWarmupDuration

public CosmosContainerProactiveInitConfigBuilder setAggressiveWarmupDuration(Duration aggressiveWarmupDuration)

Sets the time window represented as a Duration within which connections will be opened aggressively and in a blocking manner and outside which connections will be opened defensively and in a non-blocking manner

Parameters:

aggressiveWarmupDuration - this denotes the aggressive proactive connection establishment duration to be set

Returns:

current CosmosContainerProactiveInitConfigBuilder

build

public CosmosContainerProactiveInitConfig build()

Builds CosmosContainerProactiveInitConfig with the provided properties

Returns:

an instance of CosmosContainerProactiveInitConfig