ApiLimitMetric

com.google.api.server.spi.config

Annotation Type ApiLimitMetric


  • public @interface ApiLimitMetric
    A rate limiting metric.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element and Description
      int limit
      The default cost limit.
      java.lang.String name
      A limit identifier, consisting of alphanumeric characters and hyphens.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element and Description
      java.lang.String displayName
      A human readable description of the metric, e.g.

    • Element Detail

      • name

        public abstract java.lang.String name
        A limit identifier, consisting of alphanumeric characters and hyphens.

      • limit

        public abstract int limit
        The default cost limit.

      • displayName

        public abstract java.lang.String displayName
        A human readable description of the metric, e.g. Bookstore Read API Requests per Minute.
        Default:
        ""