org.apache.flink.streaming.api.operators.OutputTypeConfigurable Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of flink-streaming-java_2.12 Show documentation

There is a newer version: 1.14.6

Show newest version

/*
 * 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.streaming.api.operators;

import org.apache.flink.annotation.PublicEvolving;
import org.apache.flink.api.common.ExecutionConfig;
import org.apache.flink.api.common.typeinfo.TypeInformation;

/**
 * Stream operators can implement this interface if they need access to the output type information
 * at {@link org.apache.flink.streaming.api.graph.StreamGraph} generation. This can be useful for
 * cases where the output type is specified by the returns method and, thus, after the stream
 * operator has been created.
 */
@PublicEvolving
public interface OutputTypeConfigurable {

    /**
     * Is called by the {@link org.apache.flink.streaming.api.graph.StreamGraph#addOperator(Integer,
     * String, StreamOperator, TypeInformation, TypeInformation, String)} method when the {@link
     * org.apache.flink.streaming.api.graph.StreamGraph} is generated. The method is called with the
     * output {@link TypeInformation} which is also used for the {@link
     * org.apache.flink.streaming.runtime.tasks.StreamTask} output serializer.
     *
     * @param outTypeInfo Output type information of the {@link
     *     org.apache.flink.streaming.runtime.tasks.StreamTask}
     * @param executionConfig Execution configuration
     */
    void setOutputType(TypeInformation outTypeInfo, ExecutionConfig executionConfig);
}