Package org.springframework.data.gemfire.mapping.annotation

Annotation Interface ClientRegion

@Target(TYPE) @Retention(RUNTIME) @Inherited @Documented @Region public @interface ClientRegion
Annotation defining the Client Region in which the application persistent entity will be stored.
Since:
1.9.0
See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    diskStoreName
    Name of the DiskStore in which this persistent entity's data is overflowed and/or persisted.
    boolean
    diskSynchronous
    Determines whether disk-based operations (used in overflow and persistence) are synchronous or asynchronous.
    boolean
    ignoreIfExists
    Determines whether an entity annotated with this Region annotation will ignore any existing Region definition identified by the given name() for this entity.
    String
    name
    Name, or fully-qualified bean name of the Region in which the application persistent entity will be stored (e.g.
    String
    poolName
    Name of the GemFire/Geode Pool used by this persistent entity's Region data access operations sent to the corresponding Region on the GemFire/Geode Server.
    org.apache.geode.cache.client.ClientRegionShortcut
    shortcut
    ClientRegionShortcut used by this persistent entity's client Region to define the DataPolicy.
    String
    value
    Name, or fully-qualified bean name of the Region in which the application persistent entity will be stored (e.g.

  • Element Details

    • name

      @AliasFor(annotation=Region.class, attribute="name") String name
      Name, or fully-qualified bean name of the Region in which the application persistent entity will be stored (e.g. "Users", or "/Local/Admin/Users"). Defaults to simple name of the application persistent entity defined by Class.getSimpleName().
      Returns:
      the name or fully-qualified path of the Region in which the application persistent entity will be stored.
      Default:
      ""

    • value

      @AliasFor(annotation=Region.class, attribute="value") String value
      Name, or fully-qualified bean name of the Region in which the application persistent entity will be stored (e.g. "Users", or "/Local/Admin/Users"). Defaults to simple name of the application persistent entity defined by Class.getSimpleName().
      Returns:
      the name or fully-qualified path of the Region in which the application persistent entity will be stored.
      Default:
      ""

    • diskStoreName

      String diskStoreName
      Name of the DiskStore in which this persistent entity's data is overflowed and/or persisted. Maybe the name of a Spring bean defined in the Spring context. Defaults to unset.
      Default:
      ""

    • diskSynchronous

      boolean diskSynchronous
      Determines whether disk-based operations (used in overflow and persistence) are synchronous or asynchronous. Defaults to synchronous.
      Default:
      true

    • ignoreIfExists

      boolean ignoreIfExists
      Determines whether an entity annotated with this Region annotation will ignore any existing Region definition identified by the given name() for this entity. Defaults to true.
      Default:
      true

    • poolName

      String poolName
      Name of the GemFire/Geode Pool used by this persistent entity's Region data access operations sent to the corresponding Region on the GemFire/Geode Server. Defaults to DEFAULT.
      Default:
      "DEFAULT"

    • shortcut

      org.apache.geode.cache.client.ClientRegionShortcut shortcut
      ClientRegionShortcut used by this persistent entity's client Region to define the DataPolicy. Defaults to ClientRegionShortcut.PROXY.
      See Also:
      • ClientRegionShortcut
      Default:
      PROXY