org.apache.flink.runtime.state.OwnedTaskLocalStateStore Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of flink-runtime Show documentation

There is a newer version: 1.19.0

/*
 * 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.state;

import org.apache.flink.annotation.Internal;

import java.util.concurrent.CompletableFuture;

/**
 * This interface represents the administrative interface to {@link TaskLocalStateStore}, that only
 * the owner of the object should see. All clients that want to use the service should only see the
 * {@link TaskLocalStateStore} interface.
 */
@Internal
public interface OwnedTaskLocalStateStore extends TaskLocalStateStore {

    /**
     * Disposes the task local state store. Disposal can happen asynchronously and completion is
     * signaled through the returned future.
     */
    CompletableFuture dispose();
}