Annotation Type Action


  • @Retention(RUNTIME)
    @Target(TYPE)
    public @interface Action
    Annotation for Runnable actions accepting HTTP requests from RequestHandler.
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      Auth auth
      Authentication settings.
      java.lang.String path
      HTTP path to serve the action from.
      Action.Service service
      Which App Engine service this action lives on.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean automaticallyPrintOk
      Indicates request processor should print "OK" to the HTTP client on success.
      boolean isPrefix
      Indicates all paths starting with this path should be accepted.
      Action.Method[] method
      HTTP methods that request processor should allow.
    • Element Detail

      • service

        Action.Service service
        Which App Engine service this action lives on.
      • path

        java.lang.String path
        HTTP path to serve the action from. The path components must be percent-escaped.
      • auth

        Auth auth
        Authentication settings.
      • isPrefix

        boolean isPrefix
        Indicates all paths starting with this path should be accepted.
        Default:
        false
      • method

        Action.Method[] method
        HTTP methods that request processor should allow.
        Default:
        {google.registry.request.Action.Method.GET}
      • automaticallyPrintOk

        boolean automaticallyPrintOk
        Indicates request processor should print "OK" to the HTTP client on success.

        This is important because it's confusing to manually invoke a backend task and have a blank page show up. And it's not worth injecting a Response object just to do something so trivial.

        Default:
        false