ApiRateLimitBucket.java

// 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.ads.adwords.extension.ratelimiter;

import com.google.common.base.Preconditions;

/**
 * The rate limit bucket, so that when one bucket encounters rate limiting, other buckets may still
 * run.
 *
 * <p>Currently it only differentiates reporting service and "others".
 */
enum ApiRateLimitBucket {
  REPORTING("reporting service"),
  OTHERS("other services");

  private final String name;

  private ApiRateLimitBucket(String name) {
    this.name = Preconditions.checkNotNull(name, "The argument 'name' cannot be null!");
  }

  public String getName() {
    return name;
  }

  @Override
  public String toString() {
    return "Rate limit bucket '" + name + "'.";
  }
}