Package io.micronaut.data.cosmos.config

Class ThroughputSettings

java.lang.Object

io.micronaut.data.cosmos.config.ThroughputSettings

Direct Known Subclasses:

CosmosDatabaseConfiguration.CosmosContainerSettings.ContainerThroughputSettings, CosmosDatabaseConfiguration.DefaultThroughputSettings

public class ThroughputSettings
extends Object

Throughput settings for database and container.

Since:

3.9.0

Author:

radovanradic

Constructor Summary

Constructors

Constructor	Description
ThroughputSettings()

Method Summary

Modifier and Type	Method	Description
com.azure.cosmos.models.ThroughputProperties	createThroughputProperties()
Integer	getRequestUnits()
boolean	isAutoScale()
void	setAutoScale(boolean autoScale)	Sets the auto scaled indicator for throughput.
void	setRequestUnits(Integer requestUnits)	Sets the request units.

Methods inherited from class java.lang.Object

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

Constructor Details

ThroughputSettings

public ThroughputSettings()

Method Details

getRequestUnits

public Integer getRequestUnits()

Returns:

the request units

setRequestUnits

public void setRequestUnits(Integer requestUnits)

Sets the request units.

Parameters:

requestUnits - the request units

isAutoScale

public boolean isAutoScale()

Returns:

gets an indicator telling whether throughput is auto scaled

setAutoScale

public void setAutoScale(boolean autoScale)

Sets the auto scaled indicator for throughput.

Parameters:

autoScale - auto scale value

createThroughputProperties

public com.azure.cosmos.models.ThroughputProperties createThroughputProperties()

Returns:

an instance of ThroughputProperties based on these settings and null if requestUnits not greater than zero