org.apache.flink.runtime.resourcemanager.autoscale.hotupdate.HotUpdateConfigRetrievalListener Maven / Gradle / Ivy
/*
* 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.flink.runtime.resourcemanager.autoscale.hotupdate;
import org.apache.flink.runtime.resourcemanager.autoscale.utils.HotUpdateConfiguration;
import javax.annotation.Nullable;
/**
* Classes which want to be notified about a hot-update configuration by the {@link HotUpdateConfigRetrievalService}
* have to implement this interface.
*/
public interface HotUpdateConfigRetrievalListener {
/**
* This method is called by the {@link HotUpdateConfigRetrievalService} when a new leader is elected.
*
* @param hotUpdateConfig The updated configuration for {@link org.apache.flink.runtime.resourcemanager.autoscale.ResourceAutoScaler}
*/
void notifyUpdateConfig(@Nullable HotUpdateConfiguration hotUpdateConfig);
/**
* This method is called by the {@link HotUpdateConfigRetrievalService} in case of an exception. This
* assures that the {@link HotUpdateConfigRetrievalListener} is aware of any problems occurring in the
* {@link HotUpdateConfigRetrievalService} thread.
* @param exception
*/
void handleError(Exception exception);
}