001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.quotas;
019
020import java.util.Optional;
021import org.apache.yetus.audience.InterfaceAudience;
022
023/**
024 * A point-in-time view of a space quota on a table, read only.
025 */
026@InterfaceAudience.Public
027public interface SpaceQuotaSnapshotView {
028
029  /**
030   * Encapsulates the state of a quota on a table. The quota may or may not be in violation. If the
031   * quota is not in violation, the violation may not be presented. If the quota is in violation,
032   * there is guaranteed to be presented.
033   */
034  @InterfaceAudience.Public
035  interface SpaceQuotaStatusView {
036    /**
037     * Returns the violation policy, which may not be presented. It is guaranteed to be presented if
038     * {@link #isInViolation()} is {@code true}, but may not be presented otherwise.
039     */
040    Optional<SpaceViolationPolicy> getPolicy();
041
042    /** Returns {@code true} if the quota is being violated, {@code false} otherwise. */
043    boolean isInViolation();
044  }
045
046  /**
047   * Returns the status of the quota.
048   */
049  SpaceQuotaStatusView getQuotaStatus();
050
051  /**
052   * Returns the current usage, in bytes, of the target (e.g. table, namespace).
053   */
054  long getUsage();
055
056  /**
057   * Returns the limit, in bytes, of the target (e.g. table, namespace).
058   */
059  long getLimit();
060}