org.apache.hudi.utilities.streamer.ConfigurationHotUpdateStrategy 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.utilities.streamer;

import org.apache.hudi.common.config.TypedProperties;
import org.apache.hudi.common.util.Option;

/**
 * Hot update strategy for delta streamer configuration.
 */
public abstract class ConfigurationHotUpdateStrategy {

  protected HoodieStreamer.Config cfg;
  protected TypedProperties properties;

  public ConfigurationHotUpdateStrategy(HoodieStreamer.Config cfg,
                                        TypedProperties properties) {
    this.cfg = cfg;
    this.properties = properties;
  }

  /**
   * Update the current config properties with plugin logic.
   *
   * @param currentProps Current props to be updated
   *
   * @return A new copy of the props if any config option is updated
   * or empty if no update happens.
   */
  public abstract Option updateProperties(TypedProperties currentProps);
}