Package com.google.cloud.spring.data.firestore.mapping

Interface FirestorePersistentEntity<T>

Type Parameters:
T - the type of the property described by this persistent property
All Superinterfaces:
Iterable<FirestorePersistentProperty>, org.springframework.data.mapping.model.MutablePersistentEntity<T,FirestorePersistentProperty>, org.springframework.data.mapping.PersistentEntity<T,FirestorePersistentProperty>
All Known Implementing Classes:
FirestorePersistentEntityImpl
public interface FirestorePersistentEntity<T> extends org.springframework.data.mapping.model.MutablePersistentEntity<T,FirestorePersistentProperty>
Persistent entity for Google Cloud Firestore.
Since:
1.2

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    collectionName()
    Gets the name of the Firestore Collection.
    FirestorePersistentProperty
    getIdPropertyOrFail()
    Gets the ID property, and will throw Exception if the entity does not have an ID property.
    FirestorePersistentProperty
    getUpdateTimeProperty()
     

    Methods inherited from interface java.lang.Iterable

    forEach, iterator, spliterator

    Methods inherited from interface org.springframework.data.mapping.model.MutablePersistentEntity

    addAssociation, addPersistentProperty, setEvaluationContextProvider, setPersistentPropertyAccessorFactory, verify

    Methods inherited from interface org.springframework.data.mapping.PersistentEntity

    doWithAll, doWithAssociations, doWithAssociations, doWithProperties, doWithProperties, findAnnotation, getIdentifierAccessor, getIdProperty, getInstanceCreatorMetadata, getName, getPersistenceConstructor, getPersistentProperties, getPersistentProperty, getPersistentProperty, getPropertyAccessor, getPropertyPathAccessor, getRequiredAnnotation, getRequiredIdProperty, getRequiredPersistentProperty, getRequiredVersionProperty, getType, getTypeAlias, getTypeInformation, getVersionProperty, hasIdProperty, hasVersionProperty, isAnnotationPresent, isConstructorArgument, isCreatorArgument, isIdProperty, isImmutable, isNew, isVersionProperty, requiresPropertyPopulation

  • Method Details

    • collectionName

      String collectionName()
      Gets the name of the Firestore Collection.
      Returns:
      the name of the Firestore Collection that stores these entities.

    • getIdPropertyOrFail

      FirestorePersistentProperty getIdPropertyOrFail()
      Gets the ID property, and will throw Exception if the entity does not have an ID property.
      Returns:
      the ID property.

    • getUpdateTimeProperty

      FirestorePersistentProperty getUpdateTimeProperty()