connector/write/WriterCommitMessage.java

0001 /*
0002  * Licensed to the Apache Software Foundation (ASF) under one or more
0003  * contributor license agreements.  See the NOTICE file distributed with
0004  * this work for additional information regarding copyright ownership.
0005  * The ASF licenses this file to You under the Apache License, Version 2.0
0006  * (the "License"); you may not use this file except in compliance with
0007  * the License.  You may obtain a copy of the License at
0008  *
0009  *    http://www.apache.org/licenses/LICENSE-2.0
0010  *
0011  * Unless required by applicable law or agreed to in writing, software
0012  * distributed under the License is distributed on an "AS IS" BASIS,
0013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0014  * See the License for the specific language governing permissions and
0015  * limitations under the License.
0016  */
0017
0018 package org.apache.spark.sql.connector.write;
0019
0020 import java.io.Serializable;
0021
0022 import org.apache.spark.annotation.Evolving;
0023 import org.apache.spark.sql.connector.write.streaming.StreamingWrite;
0024
0025 /**
0026  * A commit message returned by {@link DataWriter#commit()} and will be sent back to the driver side
0027  * as the input parameter of {@link BatchWrite#commit(WriterCommitMessage[])} or
0028  * {@link StreamingWrite#commit(long, WriterCommitMessage[])}.
0029  *
0030  * This is an empty interface, data sources should define their own message class and use it when
0031  * generating messages at executor side and handling the messages at driver side.
0032  *
0033  * @since 3.0.0
0034  */
0035 @Evolving
0036 public interface WriterCommitMessage extends Serializable {}