org.springframework.data.gemfire.mapping.annotation

Annotation Type ClientRegion

@Target(value=TYPE)
 @Retention(value=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

Author:

John Blum

See Also:

EnableEntityDefinedRegions, EntityDefinedRegionsConfiguration, Region

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and 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 Detail

name

@AliasFor(annotation=Region.class,
          attribute="name")
public abstract 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")
public abstract 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

public abstract 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

public abstract boolean diskSynchronous

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

Default:

true

ignoreIfExists

public abstract 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

public abstract 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

public abstract 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:

org.apache.geode.cache.client.ClientRegionShortcut.PROXY