Package org.springframework.data.gemfire.config.annotation

Annotation Interface EnableOffHeap

@Target(TYPE) @Retention(RUNTIME) @Inherited @Documented @Import(OffHeapConfiguration.class) @UsesGemFireProperties public @interface EnableOffHeap
The EnableOffHeap annotation marks a Spring @Configuration annotated application Class to configure and enable Off-Heap Memory data storage in cache Regions.
Since:
1.9.0
Author:
John Blum
See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    memorySize
    Specifies the size of off-heap memory in megabytes (m) or gigabytes (g).

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    regionNames
    Identifies all the Regions by name in which the Off-Heap Memory settings will be applied.

  • Element Details

    • memorySize

      String memorySize
      Specifies the size of off-heap memory in megabytes (m) or gigabytes (g). For example: 
           
       off-heap-memory-size=4096m
       off-heap-memory-size=120g
      Defaults to unset. Use the spring.data.gemfire.cache.off-heap.memory-size property in application.properties.

    • regionNames

      String[] regionNames
      Identifies all the Regions by name in which the Off-Heap Memory settings will be applied. Defaults to all Regions. Use the spring.data.gemfire.cache.off-heap.region-names property in application.properties.
      Default:
      {}