com.azure.spring.data.cosmos.core.mapping

Annotation Type Container

@Inherited
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface Container

Annotation for Cosmos Container

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	autoCreateContainer To set if create container automatically
boolean	autoScale To enable auto scale for container RU limit
String	containerName To set container name
String	partitionKeyPath To set the partition key definition for container Should only be used for nested partition key scenario.
String	ru To set request unit
int	timeToLive To set the ttl of container level

Element Detail

containerName

public abstract String containerName

To set container name

Returns:

String

Default:

""

ru

public abstract String ru

To set request unit

Returns:

default as ""

Default:

""

timeToLive

public abstract int timeToLive

To set the ttl of container level

Returns:

default as no ttl

Default:

-1

autoCreateContainer

public abstract boolean autoCreateContainer

To set if create container automatically

Returns:

default as true

Default:

true

partitionKeyPath

public abstract String partitionKeyPath

To set the partition key definition for container Should only be used for nested partition key scenario. For general partition key support, use the PartitionKey annotation By default PartitionKey annotation will take precedence, unless not specified.

Returns:

partition key path

Default:

""

autoScale

public abstract boolean autoScale

To enable auto scale for container RU limit

Returns:

default as false

Default:

false