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.regionserver.compactions;
019
020import java.util.Collection;
021import org.apache.hadoop.hbase.HBaseInterfaceAudience;
022import org.apache.hadoop.hbase.regionserver.StoreFile;
023import org.apache.yetus.audience.InterfaceAudience;
024
025/**
026 * Coprocessors use this interface to get details about compaction.
027 */
028@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)
029public interface CompactionRequest {
030
031  /** Returns unmodifiable collection of StoreFiles in compaction */
032  Collection<? extends StoreFile> getFiles();
033
034  /** Returns total size of all StoreFiles in compaction */
035  long getSize();
036
037  /** Returns <code>true</code> if major compaction or all files are compacted */
038  boolean isAllFiles();
039
040  /** Returns <code>true</code> if major compaction */
041  boolean isMajor();
042
043  /** Returns priority of compaction request */
044  int getPriority();
045
046  /** Returns <code>true</code> if compaction is Off-peak */
047  boolean isOffPeak();
048
049  /** Returns compaction request creation time in milliseconds */
050  long getSelectionTime();
051
052}