org.springframework.data.gemfire.function.annotation
Annotation Type GemfireFunction


@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface GemfireFunction

Used to declare a concrete method as a GemFire function implementation


Optional Element Summary
 int batchSize
          Controls the maximum number of results sent at one time.
 boolean HA
          Attribute to determine whether the GemFire Function is HA (Highly Available).
 boolean hasResult
          Normally follows the method return type, i.e., false if void, true otherwise.
 String id
          The name of the registered function.
 boolean optimizeForWrite
          Attribute to determine whether the GemFire Function is optimized for write operations.
 

id

public abstract String id
The name of the registered function. If not provided the simple method name will be used

Returns:
the function id
Default:
""

HA

public abstract boolean HA
Attribute to determine whether the GemFire Function is HA (Highly Available).

Returns:
a boolean value indicating whether the defined GemFire Function is HA.
Default:
false

optimizeForWrite

public abstract boolean optimizeForWrite
Attribute to determine whether the GemFire Function is optimized for write operations.

Returns:
a boolean value indicating if the GemFire Function is configured for optimized write operations.
Default:
false

batchSize

public abstract int batchSize
Controls the maximum number of results sent at one time.

Returns:
an integer value indicating the batch size, or the number of results sent at one time.
Default:
0

hasResult

public abstract boolean hasResult
Normally follows the method return type, i.e., false if void, true otherwise. This allows overriding a void method which uses the resultSender directly.

Returns:
a boolean value indicating if the GemFire Function is expected to return a result.
Default:
false