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 /** 032 * @return unmodifiable collection of StoreFiles in compaction 033 */ 034 Collection<? extends StoreFile> getFiles(); 035 036 /** 037 * @return total size of all StoreFiles in compaction 038 */ 039 long getSize(); 040 041 /** 042 * @return <code>true</code> if major compaction or all files are compacted 043 */ 044 boolean isAllFiles(); 045 046 /** 047 * @return <code>true</code> if major compaction 048 */ 049 boolean isMajor(); 050 051 /** 052 * @return priority of compaction request 053 */ 054 int getPriority(); 055 056 /** 057 * @return <code>true</code> if compaction is Off-peak 058 */ 059 boolean isOffPeak(); 060 061 /** 062 * @return compaction request creation time in milliseconds 063 */ 064 long getSelectionTime(); 065 066}