Package com.google.cloud.spring.data.datastore.core.mapping

Interface DatastorePersistentProperty

All Superinterfaces:
org.springframework.data.mapping.PersistentProperty<DatastorePersistentProperty>
All Known Implementing Classes:
DatastorePersistentPropertyImpl
public interface DatastorePersistentProperty extends org.springframework.data.mapping.PersistentProperty<DatastorePersistentProperty>
Persistent property for Google Cloud Datastore.
Since:
1.1

  • Method Summary

    Modifier and Type
    Method
    Description
    EmbeddedType
    getEmbeddedType()
    Get the EmbeddedType of the property indicating what what type of embedding pathway will be used to store the property.
    String
    getFieldName()
    Get the name of the field to store this property in Datastore.
    boolean
    isColumnBacked()
    True if the property is stored within Datastore entity.
    boolean
    isDescendants()
    Whether the property contains entities that are related to this entity via the Cloud Datastore Ancestor relationship and have this entity as their ancestor.
    boolean
    isLazyLoaded()
    Return whether this property is a lazily-fetched one.
    default boolean
    isSkipNullValue()
    Return whether to skip null value, i.e., skip insertion if value is null.
    boolean
    isUnindexed()
    True if the property should be excluded from indexes.

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

    findAnnotation, findPropertyOrOwnerAnnotation, getAccessorForOwner, getActualType, getAssociation, getAssociationTargetType, getAssociationTargetTypeInformation, getComponentType, getField, getGetter, getMapValueType, getName, getOwner, getPersistentEntityTypeInformation, getRawType, getRequiredAnnotation, getRequiredAssociation, getRequiredField, getRequiredGetter, getRequiredSetter, getRequiredWither, getSetter, getSpelExpression, getType, getTypeInformation, getWither, hasActualTypeAnnotation, isAnnotationPresent, isArray, isAssociation, isCollectionLike, isEntity, isIdProperty, isImmutable, isMap, isReadable, isTransient, isVersionProperty, isWritable, usePropertyAccess

  • Method Details

    • getFieldName

      String getFieldName()
      Get the name of the field to store this property in Datastore.
      Returns:
      the string name of the field.

    • isDescendants

      boolean isDescendants()
      Whether the property contains entities that are related to this entity via the Cloud Datastore Ancestor relationship and have this entity as their ancestor.
      Returns:
      true if the property contains child entities. false otherwise.

    • isUnindexed

      boolean isUnindexed()
      True if the property should be excluded from indexes.
      Returns:
      true if the property should be indexed

    • getEmbeddedType

      EmbeddedType getEmbeddedType()
      Get the EmbeddedType of the property indicating what what type of embedding pathway will be used to store the property.
      Returns:
      the embedded type.

    • isColumnBacked

      boolean isColumnBacked()
      True if the property is stored within Datastore entity.
      Returns:
      true if the property is stored within Datastore entity

    • isLazyLoaded

      boolean isLazyLoaded()
      Return whether this property is a lazily-fetched one.
      Returns:
      true if the property is lazily-fetched. false otherwise.

    • isSkipNullValue

      default boolean isSkipNullValue()
      Return whether to skip null value, i.e., skip insertion if value is null.
      Returns:
      true if the null value is skipped. false otherwise.