ApiFrontendLimitRule

com.google.api.server.spi.config

Annotation Type ApiFrontendLimitRule


  • @Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface ApiFrontendLimitRule
    Annotation for configuration of API quota frontend limit rules.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element and Description
      java.lang.String analyticsId
      Logs traffic for this rule under a specific analytics project id.
      int daily
      The total queries per day to allow for this rule.
      java.lang.String match
      The matching rule that defines this segment.
      int qps
      The total queries per second to allow for this rule.
      int userQps
      The per-user queries per second to allow for this rule.

    • Element Detail

      • match

        public abstract java.lang.String match
        The matching rule that defines this segment. You can define the match in terms of headers or query parameters. For example "Referer=.*\.example\.com" will define a match for traffic from the example.com site. The first matching rule will be used to define the limits for a particular request.
        Default:
        ""

      • qps

        public abstract int qps
        The total queries per second to allow for this rule. The default is unlimited.
        Default:
        -1

      • userQps

        public abstract int userQps
        The per-user queries per second to allow for this rule. The default is unlimited.
        Default:
        -1

      • daily

        public abstract int daily
        The total queries per day to allow for this rule. The default is unlimited.
        Default:
        -1

      • analyticsId

        public abstract java.lang.String analyticsId
        Logs traffic for this rule under a specific analytics project id.
        Default:
        ""