Package org.apache.flink.datastream.api.stream

Interface ProcessConfigurable<T extends ProcessConfigurable<T>>

All Known Subinterfaces:
GlobalStream.ProcessConfigurableAndGlobalStream<T>, KeyedPartitionStream.ProcessConfigurableAndKeyedPartitionStream<K,T>, KeyedPartitionStream.ProcessConfigurableAndTwoKeyedPartitionStreams<K,T1,T2>, NonKeyedPartitionStream.ProcessConfigurableAndNonKeyedPartitionStream<T>, NonKeyedPartitionStream.ProcessConfigurableAndTwoNonKeyedPartitionStream<OUT1,OUT2>
@Experimental public interface ProcessConfigurable<T extends ProcessConfigurable<T>>
This represents the configuration handle of processing. Many processing-related properties can be set through the `withYYY` method provided by this interface, such as withName, withUid, etc.

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    withMaxParallelism(int maxParallelism)
    Sets the maximum parallelism of this operator.
    T
    withName(String name)
    Sets the name of the current data stream.
    T
    withParallelism(int parallelism)
    Sets the parallelism for this process operator.
    T
    withSlotSharingGroup(org.apache.flink.api.common.SlotSharingGroup slotSharingGroup)
    Sets the slot sharing group of this operation.
    T
    withUid(String uid)
    Sets an ID for this operator.

  • Method Details

    • withUid

      T withUid(String uid)
      Sets an ID for this operator.

      The specified ID is used to assign the same process operator ID across job submissions (for example when starting a job from a savepoint).

      Important: this ID needs to be unique per transformation and job. Otherwise, job submission will fail.

      Parameters:
      uid - The unique user-specified ID of this transformation.
      Returns:
      The operator with the specified ID.

    • withName

      T withName(String name)
      Sets the name of the current data stream. This name is used by the visualization and logging during runtime.
      Returns:
      The named operator.

    • withParallelism

      T withParallelism(int parallelism)
      Sets the parallelism for this process operator.
      Parameters:
      parallelism - The parallelism for this operator.
      Returns:
      The operator with set parallelism.

    • withMaxParallelism

      T withMaxParallelism(int maxParallelism)
      Sets the maximum parallelism of this operator.

      The maximum parallelism specifies the upper bound for dynamic scaling. It also defines the number of key groups used for partitioned state.

      Parameters:
      maxParallelism - Maximum parallelism
      Returns:
      The operator with set maximum parallelism

    • withSlotSharingGroup

      T withSlotSharingGroup(org.apache.flink.api.common.SlotSharingGroup slotSharingGroup)
      Sets the slot sharing group of this operation. Parallel instances of operations that are in the same slot sharing group will be co-located in the same TaskManager slot, if possible.

      Operations inherit the slot sharing group of input operations if all input operations are in the same slot sharing group and no slot sharing group was explicitly specified.

      Initially an operation is in the default slot sharing group. An operation can be put into the default group explicitly by setting the slot sharing group with name "default".

      Parameters:
      slotSharingGroup - Which contains name and its resource spec.