Package com.experian.datastudio.sdk.unifiedapi.step.processor

Interface ProcessingContext

public interface ProcessingContext

  • Method Details

    • getStepPropertyValue

      <T> T getStepPropertyValue(String stepPropertyId, Class<T> type, T defaultValue)
      Convenience method to get arg value when the user option type is DefaultOption type.
      Type Parameters:
      T - The type of value the arg would return. e.g StringStepProperty would return String value.
      Parameters:
      stepPropertyId - the arg id
      Returns:
      The arg value.

    • getColumnFromChooserValues

      List<Column> getColumnFromChooserValues(String columnChooserId)
      Convenience method to returns the columns selected by the user. It will return empty list if the column chooser is invalid or the step property is not a column chooser.
      Parameters:
      columnChooserId - the column chooser's step property ID
      Returns:
      the list of selected Column

    • getStepSettingFieldValueAsString

      Optional<String> getStepSettingFieldValueAsString(String stepSettingFieldId)
      Returns the step setting field value as a string based on the step setting field ID specified.
      Parameters:
      stepSettingFieldId - ID of the step setting field to be returned
      Returns:
      String value of the step setting field

    • isInteractive

      boolean isInteractive()
      Interactive is a flag that set to `true` when the user views the output of a step on the Data Studio Grid (UI). It is set to `false` when running the whole workflow as a Job.
      Returns:
      true if the execution is interactive, otherwise false

    • getColumns

      List<Column> getColumns()
      Returns the columns from the input to a custom step.
      Returns:
      List of InputColumn to the custom step

    • getColumnById

      Optional<Column> getColumnById(String id)
      Returns the column from the input to a custom step. Column is specified by the ID.
      Parameters:
      id - ID of column to be returned
      Returns:
      InputColumn with specified ID

    • getColumnsByTag

      List<Column> getColumnsByTag(String tag)
      Returns the list of input columns by tag.
      Parameters:
      tag - data tag
      Returns:
      List of input columns
      Since:
      2.3.0

    • getOutputBuilder

      OutputRecordBuilder getOutputBuilder()
      Returns the builder class for output record
      Returns:
      builder class for output record