Package io.micronaut.data.cosmos.config

Class CosmosDatabaseConfiguration

java.lang.Object

io.micronaut.data.cosmos.config.CosmosDatabaseConfiguration

@ConfigurationProperties("azure.cosmos.database")
public final class CosmosDatabaseConfiguration
extends Object

The Azure Cosmos database configuration.

Since:

3.9.0

Author:

radovanradic

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CosmosDatabaseConfiguration.CosmosContainerSettings	The settings for Cosmos container.
static final class	CosmosDatabaseConfiguration.DefaultThroughputSettings	Throughput settings for database.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX

Constructor Summary

Constructors

Constructor	Description
CosmosDatabaseConfiguration()

Method Summary

Modifier and Type	Method	Description
List<CosmosDatabaseConfiguration.CosmosContainerSettings>	getContainers()
String	getDatabaseName()
List<String>	getPackages()
ThroughputSettings	getThroughput()
StorageUpdatePolicy	getUpdatePolicy()
boolean	isQueryMetricsEnabled()	Gets the indicator telling whether query metrics will be enabled for Azure Cosmos Db query requests.
void	setContainers(List<CosmosDatabaseConfiguration.CosmosContainerSettings> containers)
void	setDatabaseName(String databaseName)	Sets the database name.
void	setPackages(List<String> packages)
void	setQueryMetricsEnabled(boolean queryMetricsEnabled)	Sets the indicator telling whether query metrics will be enabled for Azure Cosmos Db query requests.
void	setThroughput(ThroughputSettings throughput)
void	setUpdatePolicy(StorageUpdatePolicy updatePolicy)	Sets the update policy for the database to be used during startup.

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

See Also:

• Constant Field Values

Constructor Details

CosmosDatabaseConfiguration

public CosmosDatabaseConfiguration()

Method Details

getThroughput

public ThroughputSettings getThroughput()

setThroughput

@Inject
public void setThroughput(ThroughputSettings throughput)

getContainers

public List<CosmosDatabaseConfiguration.CosmosContainerSettings> getContainers()

setContainers

@Inject
public void setContainers(List<CosmosDatabaseConfiguration.CosmosContainerSettings> containers)

getDatabaseName

@NonNull
public String getDatabaseName()

Returns:

the database name

setDatabaseName

public void setDatabaseName(String databaseName)

Sets the database name.

Parameters:

databaseName - the database name

getUpdatePolicy

public StorageUpdatePolicy getUpdatePolicy()

Returns:

the update policy for the database to be used during startup.

setUpdatePolicy

public void setUpdatePolicy(StorageUpdatePolicy updatePolicy)

Sets the update policy for the database to be used during startup.

Parameters:

updatePolicy - the update policy for the database

getPackages

public List<String> getPackages()

Returns:

the list of package names to filter entities during init database and containers

setPackages

public void setPackages(List<String> packages)

Parameters:

packages - the package names to be considered during init

isQueryMetricsEnabled

public boolean isQueryMetricsEnabled()

Gets the indicator telling whether query metrics will be enabled for Azure Cosmos Db query requests. If this is turned off then detailed query metrics information will not be retrieved in the Cosmos Diagnostics query response. The default value is true.

Returns:

the query metrics enabled indicator

setQueryMetricsEnabled

public void setQueryMetricsEnabled(boolean queryMetricsEnabled)

Sets the indicator telling whether query metrics will be enabled for Azure Cosmos Db query requests.

Parameters:

queryMetricsEnabled - the query metrics enabled indicator