Package org.springframework.data.gemfire.function.annotation

Annotation Interface GemfireFunction

@Retention(RUNTIME) @Target(METHOD) public @interface GemfireFunction
Used to declare a concrete method as a GemFire function implementation
Author:
David Turanski

  • Field Details

  • Element Details

    • id

      String id
      The name of the registered Function. If not provided the simple method name will be used.
      Returns:
      the Function id.
      See Also:
      Default:
      ""

    • batchSize

      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

    • HA

      boolean HA
      Attribute used to configure whether the Function is HA (Highly Available).
      Returns:
      a boolean value configuring whether the defined Function is HA.
      See Also:
      Default:
      false

    • hasResult

      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 Function is expected to return a result.
      See Also:
      Default:
      false

    • optimizeForWrite

      boolean optimizeForWrite
      Attribute to configure whether the Function is optimized for write operations.
      Returns:
      a boolean value indicating if the Function is configured for optimized write operations.
      See Also:
      Default:
      false

    • requiredPermissions

      String[] requiredPermissions
      Returns the list of ResourcePermission required by this Function. By default, Functions require DATA:WRITE permission.
      Default:
      {"DATA:WRITE"}