com.google.api.server.spi.config.ApiLimitMetric Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of endpoints-framework Show documentation

A framework for building RESTful web APIs.

The newest version!

/*
 * Copyright 2017 Google Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.google.api.server.spi.config;

/**
 * A rate limiting metric.
 */
public @interface ApiLimitMetric {
  /**
   * A limit identifier, consisting of alphanumeric characters and hyphens.
   */
  String name();

  /**
   * A human readable description of the metric, e.g. Bookstore Read API Requests per Minute.
   */
  String displayName() default "";

  /**
   * The default cost limit.
   */
  int limit();
}