Page History

package org.apache.flink.streaming.api.operators;

/** The builder class for {@link OperatorAttributes}. */
@PublicEvolving
public class OperatorAttributesBuilder {
    @Nullable private Boolean isOutputOnEOFoutputOnEOF = null;
    @Nullable private Boolean isOutputOnCheckpointoutputOnCheckpoint = null; 
    @Nullable private Boolean isInternalSorterSupportedinternalSorterSupported = null; 

    public OperatorAttributesBuilder() {...}

    public OperatorAttributesBuilder setIsOutputOnEOFsetOutputOnEOF(boolean isOutputOnEOFoutputOnEOF) {...}

    public OperatorAttributesBuilder setIsOutputOnCheckpointsetOutputOnCheckpoint(boolean isOutputOnCheckpointoutputOnCheckpoint) {...}

    public OperatorAttributesBuilder setIsInternalSorterSupportedsetInternalSorterSupported(boolean isInternalSorterSupportedinternalSorterSupported) {...}

    /**
     * If any operator attribute is null, we will log it at DEBUG level and use the following
     * default values.
     * - isOutputOnEOFoutputOnEOF defaults to false
     * - isOutputOnCheckpointoutputOnCheckpoint defaults to false
     * - isInternalSorterSupportedinternalSorterSupported defaults to false
     */ 
     public OperatorAttributes build() {...}
}

package org.apache.flink.streaming.api.operators;

/**
 * OperatorAttributes element provides Job Manager with information that can be
 * used to optimize the job performance.
 */
@PublicEvolving
public class OperatorAttributes {     
   /**
     * Returns true iff the operator can only emit records after inputs have reached EOF.
     *
     * <p>Here are the implications when it is true:
     *
     * <ul>
     *   <li>Its output edges are blocking.
     *   <li>The PipelinedRegion containing this operator has checkpoint disabled.
     * </ul>
     */
    public boolean getIsOutputOnEOFisOutputOnEOF() {...}

    /**
     * Returns true iff the operator can only emit records when checkpoint is triggered.
     *
     * <p>If true, the job should trigger checkpoint in order to flush data to sinks.
     */
    public boolean getIsOutputOnCheckpointisOutputOnCheckpoint() {...}

    /**
     * Returns true iff the operator uses an internal sorter when checkpoint is disabled.
     * 
     * <p>Checkpoint is disabled disabled in any of the following cases:
     *
     * <ul>
     *   <li>execution.runtime-mode = BATCH.
     *   <li>execution.checkpointing.interval-during-backlog = 0.
	 *   <li>It has isOutputOnEOF = true.
     * <ul>
     *
     * <p>Here are the implications when it is true AND checkpoint is disabled:
     *
     * <ul>
     *   <li>Its input records do not need to be sorted externally.
     *   <li>Its managed memory should be set according to execution.sorted-inputs.memory.
     * </ul>
     */
    public boolean getIsInternalSorterSupportedisInternalSorterSupported() {...}
}

@Internal
public abstract class Transformation<T> {
    public boolean getIsOutputOnEOFisOutputOnEOF() {
        return false;
    }

    public boolean getIsOutputOnCheckpointisOutputOnCheckpoint() {
        return false;
    }

    public boolean getIsInternalSorterSupportedisInternalSorterSupported() {
        return false;
    }
}