modules/api/src/main/java/org/apache/ignite/table/DataStreamerTarget.java

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

import java.util.concurrent.CompletableFuture;
import java.util.concurrent.Flow;
import org.jetbrains.annotations.Nullable;

/**
 * Represents an entity that can be used as a target for streaming data.
 *
 * @param <T> Entry type.
 */
@SuppressWarnings("InterfaceMayBeAnnotatedFunctional")
public interface DataStreamerTarget<T> {
    /**
     * Streams data into the underlying table.
     *
     * @param publisher Producer.
     * @param options Options (can be null).
     * @return Future that will be completed when the stream is finished.
     */
    CompletableFuture<Void> streamData(
            Flow.Publisher<T> publisher,
            @Nullable DataStreamerOptions options);
}