matriv commented on a change in pull request #18479: URL: https://github.com/apache/flink/pull/18479#discussion_r791949325
########## File path: flink-table/flink-table-planner/src/main/java/org/apache/flink/table/planner/plan/nodes/exec/ExecNodeMetadata.java ########## @@ -0,0 +1,131 @@ +/* + * 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.table.planner.plan.nodes.exec; + +import org.apache.flink.FlinkVersion; +import org.apache.flink.annotation.PublicEvolving; +import org.apache.flink.table.api.config.ExecutionConfigOptions; + +import com.fasterxml.jackson.annotation.JsonProperty; + +import java.lang.annotation.Documented; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Annotation to be used for {@link ExecNode}s to keep necessary metadata when + * serialising/deserialising them in a plan. + * + * <p>Each {@link ExecNode} needs to be annotated and provide the necessary metadata info so that it + * can be correctly serialised and later on instantiated from a string (JSON) plan. + * + * <p>It's possible for one {@link ExecNode} class to user multiple annotations to denote ability to + * upgrade to more versions. + */ +@Documented +@Target(ElementType.TYPE) +@Retention(RetentionPolicy.RUNTIME) +@PublicEvolving +public @interface ExecNodeMetadata { + // main information + + /** + * Unique name of the {@link ExecNode} for serialization/deserialization and uid() generation. + * Together with version, uniquely identifies the {@link ExecNode} class. + */ + String name(); + + /** + * A positive integer denoting the evolving version of an {@link ExecNode}, used for + * serialization/deserialization and uid() generation. Together with {@link #name()}, uniquely + * identifies the {@link ExecNode} class. + */ + @JsonProperty("version") + int version(); + + // maintenance information for internal/community/test usage + + /** + * Hard coded list of {@link ExecutionConfigOptions} keys of in the Flink version when the Review comment: Done -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
