Package io.micronaut.data.cosmos.config

Enum Class StorageUpdatePolicy

java.lang.Object

java.lang.Enum<StorageUpdatePolicy>

io.micronaut.data.cosmos.config.StorageUpdatePolicy

All Implemented Interfaces:

Serializable, Comparable<StorageUpdatePolicy>, Constable

public enum StorageUpdatePolicy
extends Enum<StorageUpdatePolicy>

This enum is used to tell how we should handle database and containers during startup.

Since:

3.9.0

Author:

radovanradic

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CREATE_IF_NOT_EXISTS	Database (or container) will be created if not exists with given properties from the configuration.
NONE	No attempt to create or update database (or container) will be made.
UPDATE	Database (or container) will be updated with the properties from the configuration.

Method Summary

Modifier and Type	Method	Description
static StorageUpdatePolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StorageUpdatePolicy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CREATE_IF_NOT_EXISTS

public static final StorageUpdatePolicy CREATE_IF_NOT_EXISTS

Database (or container) will be created if not exists with given properties from the configuration.

UPDATE

public static final StorageUpdatePolicy UPDATE

Database (or container) will be updated with the properties from the configuration.

NONE

public static final StorageUpdatePolicy NONE

No attempt to create or update database (or container) will be made.

Method Details

values

public static StorageUpdatePolicy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static StorageUpdatePolicy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null