org.apache.hudi.common.table.log.KeySpec Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.hudi.common.table.log;

import java.util.List;

/**
 * An interface to specify a set of keys that used to filter records
 * from log files. That is, only the records whose record key match
 * any of the specified keys can go to the downstream operations.
 */
public interface KeySpec {
  List getKeys();

  boolean isFullKey();

  static KeySpec fullKeySpec(List keys) {
    return new FullKeySpec(keys);
  }

  static KeySpec prefixKeySpec(List keyPrefixes) {
    return new PrefixKeySpec(keyPrefixes);
  }
}