Package org.talend.sdk.component.api.input

Annotation Type PartitionMapper

@Target(TYPE) @Retention(RUNTIME) public @interface PartitionMapper

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    family
     
    boolean
    infinite
    If the @Producer method of the underlying Emitter can return null before the data are completely read - i.e.
    String
    name
     
    boolean
    stoppable
    Allow to provide an UI to customize a set of conditions to stop the infinite loop.

  • Element Details

    • family

      String family
      Returns:
      the component of this mapper (family/grouping value).
      Default:
      ""

    • name

      String name
      Returns:
      the value of the related input.
      Default:
      ""

    • infinite

      boolean infinite
      If the @Producer method of the underlying Emitter can return null before the data are completely read - i.e. infinite flow case - then you should set true to prevent the execution to complete when null is encountered. Default cases matches a batch case whereas when set to true it matches a stream case.
      Returns:
      true if the underlying input can be used as a stream and not in batch context.
      Default:
      false

    • stoppable

      boolean stoppable
      Allow to provide an UI to customize a set of conditions to stop the infinite loop. Only valid when infinite() returns true. So affects only streaming PartitionMappers. Caution: Some records may be lost according the connector's Emitter implementation. For instance, suppose that the connector maintains a queue with a size of 10 records, and we have in the stop strategy a max records set to 5. If the first 10 records are considered as acknowledged, then the 5 first records will be read but the 5 next will be considered lost.
      Returns:
      true if the underlying input can customize a stop strategy.
      Default:
      false