Package io.micronaut.data.cosmos.common

Class CosmosEntity

java.lang.Object

io.micronaut.data.cosmos.common.CosmosEntity

@Internal
public final class CosmosEntity
extends java.lang.Object

Model holding cosmos entity fields like container name, partition key, version field.

Since:

3.9.0

Author:

radovanradic

Method Summary

Modifier and Type	Method	Description
static CosmosEntity	create(RuntimePersistentEntity<?> runtimePersistentEntity, CosmosDatabaseConfiguration.CosmosContainerSettings cosmosContainerSettings)	Creates CosmosEntity from RuntimePersistentEntity and CosmosDatabaseConfiguration.CosmosContainerSettings.
static CosmosEntity	get(RuntimePersistentEntity<?> runtimePersistentEntity)	Gets CosmosEntity that was initialized during app startup for given RuntimePersistentEntity.
java.lang.String	getContainerName()
java.lang.String	getPartitionKey()
java.lang.String	getVersionField()

Methods inherited from class java.lang.Object

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

Method Detail

getContainerName

public java.lang.String getContainerName()

Returns:

the Cosmos container name for this entity

getPartitionKey

public java.lang.String getPartitionKey()

Returns:

the partition key for the Cosmos container/entity

getVersionField

public java.lang.String getVersionField()

Returns:

the version field, if any defined on the entity using ETag annotation

create

@NonNull
public static CosmosEntity create(@NonNull
                                  RuntimePersistentEntity<?> runtimePersistentEntity,
                                  CosmosDatabaseConfiguration.CosmosContainerSettings cosmosContainerSettings)

Creates CosmosEntity from RuntimePersistentEntity and CosmosDatabaseConfiguration.CosmosContainerSettings.

Parameters:

runtimePersistentEntity - the runtime persistent entity

cosmosContainerSettings - the Cosmos container settings

Returns:

the CosmosEntity holding mapped entity/container metadata

get

@NonNull
public static CosmosEntity get(@NonNull
                               RuntimePersistentEntity<?> runtimePersistentEntity)

Gets CosmosEntity that was initialized during app startup for given RuntimePersistentEntity.

Parameters:

runtimePersistentEntity - the runtime persistent entity

Returns:

the CosmosEntity holding mapped entity/container metadata