diff --git a/ExampleSteps/AddVAT/build.gradle b/ExampleSteps/AddVAT/build.gradle index 3c411cb..cda11ab 100644 --- a/ExampleSteps/AddVAT/build.gradle +++ b/ExampleSteps/AddVAT/build.gradle @@ -11,10 +11,10 @@ repositories { dependencies { compileOnly( - "com.experian.datastudio:sdkapi:2.0.0", - "com.experian.datastudio:sdklib:2.0.0" + "com.experian.datastudio:sdkapi:2.1.0", + "com.experian.datastudio:sdklib:2.1.0" ) - testImplementation "com.experian.datastudio:sdktestframework:2.0.0" + testImplementation "com.experian.datastudio:sdktestframework:2.1.0" testImplementation 'org.junit.jupiter:junit-jupiter-api:5.6.0' testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.6.0' } diff --git a/ExampleSteps/ConcatValues/build.gradle b/ExampleSteps/ConcatValues/build.gradle index 3c411cb..cda11ab 100644 --- a/ExampleSteps/ConcatValues/build.gradle +++ b/ExampleSteps/ConcatValues/build.gradle @@ -11,10 +11,10 @@ repositories { dependencies { compileOnly( - "com.experian.datastudio:sdkapi:2.0.0", - "com.experian.datastudio:sdklib:2.0.0" + "com.experian.datastudio:sdkapi:2.1.0", + "com.experian.datastudio:sdklib:2.1.0" ) - testImplementation "com.experian.datastudio:sdktestframework:2.0.0" + testImplementation "com.experian.datastudio:sdktestframework:2.1.0" testImplementation 'org.junit.jupiter:junit-jupiter-api:5.6.0' testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.6.0' } diff --git a/ExampleSteps/IPGeolocation/build.gradle b/ExampleSteps/IPGeolocation/build.gradle index b337bda..6eb8be6 100644 --- a/ExampleSteps/IPGeolocation/build.gradle +++ b/ExampleSteps/IPGeolocation/build.gradle @@ -18,15 +18,15 @@ repositories { dependencies { compileOnly( - "com.experian.datastudio:sdkapi:2.0.0", - "com.experian.datastudio:sdklib:2.0.0" + "com.experian.datastudio:sdkapi:2.1.0", + "com.experian.datastudio:sdklib:2.1.0" ) implementation( 'commons-io:commons-io:2.6', "org.json:json:20160810", "org.apache.commons:commons-lang3:3.9" ) - testImplementation "com.experian.datastudio:sdktestframework:2.0.0" + testImplementation "com.experian.datastudio:sdktestframework:2.1.0" testImplementation 'org.junit.jupiter:junit-jupiter-api:5.6.0' testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.6.0' } diff --git a/ExampleSteps/IPGeolocation/src/main/java/com/experian/aperture/datastudio/sdk/step/examples/IPGeolocation.java b/ExampleSteps/IPGeolocation/src/main/java/com/experian/aperture/datastudio/sdk/step/examples/IPGeolocation.java index 2421012..6e58277 100644 --- a/ExampleSteps/IPGeolocation/src/main/java/com/experian/aperture/datastudio/sdk/step/examples/IPGeolocation.java +++ b/ExampleSteps/IPGeolocation/src/main/java/com/experian/aperture/datastudio/sdk/step/examples/IPGeolocation.java @@ -62,6 +62,7 @@ public StepConfiguration createConfiguration(StepConfigurationBuilder configurat .withId(SETTING_ID) .withName("Lang Localization Setting (e.g. en, de, zh-CN)") .withIsRequired(true) + .withFieldType(StepSettingType.TEXT) .build()) .build()) .build(); diff --git a/README.md b/README.md index 6b05ce5..6d25830 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,7 @@ This repo contains the SDK JAR and a pre-configured Java project that uses Gradl - [Destroy cache](#destroy-cache) - [Assigning value to cache](#assigning-value-to-cache) - [Getting value from cache](#getting-value-from-cache) + - [Custom step exception](#custom-step-exception) - [Step setting](#step-setting) - [Creating step setting](#creating-step-setting) - [Accessing step setting](#accessing-step-setting) @@ -76,7 +77,8 @@ This repo contains the SDK JAR and a pre-configured Java project that uses Gradl | Data Studio version | Compatible SDK version | |:-------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| 2.0.0 | [2.0.0](https://github.com/experiandataquality/aperture-data-studio-sdk) | +| 2.0.6 | [2.0.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v2.0.0) — [2.1.0](https://github.com/experiandataquality/aperture-data-studio-sdk) | +| 2.0.0 | [2.0.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v2.0.0) | | 1.6.2 | [1.5.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v1.5.0) — [1.6.2](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v1.6.2) | | 1.6.1 | [1.5.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v1.5.0) — [1.6.1](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v1.6.1) | | 1.6.0 | [1.5.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v1.5.0) — [1.6.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v1.6.0) | @@ -107,14 +109,14 @@ This repo contains the SDK JAR and a pre-configured Java project that uses Gradl } dependencies { - compileOnly("com.experian.datastudio:sdkapi:2.0.0") - compileOnly("com.experian.datastudio:sdklib:2.0.0") + compileOnly("com.experian.datastudio:sdkapi:2.1.0") + compileOnly("com.experian.datastudio:sdklib:2.1.0") } ``` If you don't want to use Gradle, you'll have to configure your own Java project to generate a compatible JAR artifact: - Create a new Java project or open an existing one. - - Download and install the [sdkapi.jar](https://raw.githubusercontent.com/experiandataquality/aperture-data-studio-sdk/github-maven-repository/maven/com/experian/datastudio/sdkapi/2.0.0/sdkapi-2.0.0.jar) file. + - Download and install the [sdkapi.jar](https://raw.githubusercontent.com/experiandataquality/aperture-data-studio-sdk/github-maven-repository/maven/com/experian/datastudio/sdkapi/2.1.0/sdkapi-2.1.0.jar) file. If using Maven, modify `pom.xml` to add the SDK GitHub repository: @@ -149,13 +151,13 @@ This repo contains the SDK JAR and a pre-configured Java project that uses Gradl com.experian.datastudio sdkapi - 2.0.0 + 2.1.0 provided com.experian.datastudio sdklib - 2.0.0 + 2.1.0 @@ -623,6 +625,12 @@ If the cache contains no value for that key, `null` is returned. cache1.get(cacheKey); ``` +### Custom step exception +You can raise custom step exception by throwing the following exception class. +``` java +throw new CustomStepException(401, "Authentication failed") +``` + ### Step setting You may use step setting as a constant variable or as global setting across the Aperture Data Studio. The setting page will be appeared in *Step Setting* module. @@ -633,6 +641,7 @@ Use `CustomStepSettingBuilder` in `createConfiguration` method to configure your | withId | Set the Id for the field | | withName | Set the name for the field | | withIsRequired | Set whether the field is mandatory | +| withFieldType | Set the field type (*PASSWORD*, *TEXT*, *TEXTAREA*) | ``` java .withStepSetting(builder -> builder @@ -640,12 +649,39 @@ Use `CustomStepSettingBuilder` in `createConfiguration` method to configure your .withId("stepsetting-1") .withName("Step Setting 1") .withIsRequired(true) + .withFieldType(StepSettingType.PASSWORD) .build()) .build()) ``` #### Accessing step setting -Step setting value can be accessed from *createProcessor* methods. +Step setting value can be accessed from both *createConfiguration* and *createProcessor* methods. +``` java +.withStepProperties(stepPropertiesBuilder -> stepPropertiesBuilder + .addStepProperty(stepPropertyBuilder -> stepPropertyBuilder + .asCustomChooser("property-1") + .withAllowValuesProvider(uiCallbackContext -> { + final Optional fieldValue1 = uiCallbackContext.getStepSettingFieldValueAsString("stepsetting-1"); + return fieldValue1.map(s -> Arrays.asList(s.split(","))).orElse(Collections.emptyList()); + }) + .withIsRequired(true) + .build()) + .build()) +``` + +``` java +.withOutputLayouts(outputLayoutBuilder -> outputLayoutBuilder + .forOutputNode("output-1", outputColumnBuilder -> outputColumnBuilder + .addColumns(context -> { + final Optional fieldValue1 = context.getStepSettingFieldValueAsString("stepsetting-1"); + List columnList = context.getInputContext(INPUT_ID).getColumns(); + fieldValue1.ifPresent(s -> columnList.add(context.createNewColumn(s))); + return columnList; + }) + .addColumn(COLUMN_HEADER) + .build()) + .build()) +``` ``` java public StepProcessor createProcessor(final StepProcessorBuilder processorBuilder) { @@ -900,13 +936,13 @@ CompletableFuture webHttpResponse = client.sendAsync(request); } dependencies { - compileOnly("com.experian.datastudio:sdkapi:2.0.0") + compileOnly("com.experian.datastudio:sdkapi:2.1.0") } ``` If you don't want to use Gradle, you'll have to configure your own Java project to generate a compatible JAR artifact: - Create a new Java project or open an existing one. - - Download and install the [sdkapi.jar](https://raw.githubusercontent.com/experiandataquality/aperture-data-studio-sdk/github-maven-repository/maven/com/experian/datastudio/sdkapi/2.0.0/sdkapi-2.0.0.jar) file. + - Download and install the [sdkapi.jar](https://raw.githubusercontent.com/experiandataquality/aperture-data-studio-sdk/github-maven-repository/maven/com/experian/datastudio/sdkapi/2.1.0/sdkapi-2.1.0.jar) file. If using Maven, modify `pom.xml` to add the SDK GitHub repository: @@ -936,7 +972,7 @@ CompletableFuture webHttpResponse = client.sendAsync(request); com.experian.datastudio sdkapi - 2.0.0 + 2.1.0 provided diff --git a/SDKTestFramework/build.gradle b/SDKTestFramework/build.gradle index 3c411cb..cda11ab 100644 --- a/SDKTestFramework/build.gradle +++ b/SDKTestFramework/build.gradle @@ -11,10 +11,10 @@ repositories { dependencies { compileOnly( - "com.experian.datastudio:sdkapi:2.0.0", - "com.experian.datastudio:sdklib:2.0.0" + "com.experian.datastudio:sdkapi:2.1.0", + "com.experian.datastudio:sdklib:2.1.0" ) - testImplementation "com.experian.datastudio:sdktestframework:2.0.0" + testImplementation "com.experian.datastudio:sdktestframework:2.1.0" testImplementation 'org.junit.jupiter:junit-jupiter-api:5.6.0' testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.6.0' } diff --git a/docs/index.html b/docs/index.html index ff48618..9124e18 100644 --- a/docs/index.html +++ b/docs/index.html @@ -10,8 +10,8 @@ diff --git a/docs/sdkapi/allclasses-frame.html b/docs/sdkapi/allclasses-frame.html index aea886b..afc3f2e 100644 --- a/docs/sdkapi/allclasses-frame.html +++ b/docs/sdkapi/allclasses-frame.html @@ -3,7 +3,7 @@ -All Classes (SDKAPI 2.0.0 API) +All Classes (SDKAPI 2.1.0 API) @@ -33,6 +33,7 @@

All Classes

  • CustomDefinition
  • CustomParserDefinition
  • CustomStepDefinition
    • +
  • CustomStepException
  • CustomStepSetting
  • CustomStepSettingBuilder
  • CustomStepSettingBuilder.Build
    • @@ -140,6 +141,7 @@

    All Classes

  • StepResourceBuilder.Supplier
  • StepResourceBuilderFactory
  • StepResourceContext
    • +
  • StepSettingType
  • StringStepProperty
  • StringStepPropertyBuilder
  • SupportedFileExtension
    • diff --git a/docs/sdkapi/allclasses-noframe.html b/docs/sdkapi/allclasses-noframe.html index bab52be..d6ca7b7 100644 --- a/docs/sdkapi/allclasses-noframe.html +++ b/docs/sdkapi/allclasses-noframe.html @@ -3,7 +3,7 @@ -All Classes (SDKAPI 2.0.0 API) +All Classes (SDKAPI 2.1.0 API) @@ -33,6 +33,7 @@

    All Classes

  • CustomDefinition
  • CustomParserDefinition
  • CustomStepDefinition
    • +
  • CustomStepException
  • CustomStepSetting
  • CustomStepSettingBuilder
  • CustomStepSettingBuilder.Build
    • @@ -140,6 +141,7 @@

    All Classes

  • StepResourceBuilder.Supplier
  • StepResourceBuilderFactory
  • StepResourceContext
    • +
  • StepSettingType
  • StringStepProperty
  • StringStepPropertyBuilder
  • SupportedFileExtension
    • diff --git a/docs/sdkapi/com/experian/datastudio/sdk/api/CustomDefinition.html b/docs/sdkapi/com/experian/datastudio/sdk/api/CustomDefinition.html index fc4c162..77688a4 100644 --- a/docs/sdkapi/com/experian/datastudio/sdk/api/CustomDefinition.html +++ b/docs/sdkapi/com/experian/datastudio/sdk/api/CustomDefinition.html @@ -3,7 +3,7 @@ -CustomDefinition (SDKAPI 2.0.0 API) +CustomDefinition (SDKAPI 2.1.0 API) @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ diff --git a/docs/sdkapi/com/experian/datastudio/sdk/api/package-summary.html b/docs/sdkapi/com/experian/datastudio/sdk/api/package-summary.html index 8e927c1..5a1db6c 100644 --- a/docs/sdkapi/com/experian/datastudio/sdk/api/package-summary.html +++ b/docs/sdkapi/com/experian/datastudio/sdk/api/package-summary.html @@ -3,7 +3,7 @@ -com.experian.datastudio.sdk.api (SDKAPI 2.0.0 API) +com.experian.datastudio.sdk.api (SDKAPI 2.1.0 API) @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ diff --git a/docs/sdkapi/com/experian/datastudio/sdk/api/parser/configuration/package-summary.html b/docs/sdkapi/com/experian/datastudio/sdk/api/parser/configuration/package-summary.html index 2f72f60..ecd6262 100644 --- a/docs/sdkapi/com/experian/datastudio/sdk/api/parser/configuration/package-summary.html +++ b/docs/sdkapi/com/experian/datastudio/sdk/api/parser/configuration/package-summary.html @@ -3,7 +3,7 @@ -com.experian.datastudio.sdk.api.parser.configuration (SDKAPI 2.0.0 API) +com.experian.datastudio.sdk.api.parser.configuration (SDKAPI 2.1.0 API) @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ diff --git a/docs/sdkapi/com/experian/datastudio/sdk/api/parser/package-summary.html b/docs/sdkapi/com/experian/datastudio/sdk/api/parser/package-summary.html index 375b254..572b500 100644 --- a/docs/sdkapi/com/experian/datastudio/sdk/api/parser/package-summary.html +++ b/docs/sdkapi/com/experian/datastudio/sdk/api/parser/package-summary.html @@ -3,7 +3,7 @@ -com.experian.datastudio.sdk.api.parser (SDKAPI 2.0.0 API) +com.experian.datastudio.sdk.api.parser (SDKAPI 2.1.0 API) @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ diff --git a/docs/sdkapi/com/experian/datastudio/sdk/api/parser/processor/package-summary.html b/docs/sdkapi/com/experian/datastudio/sdk/api/parser/processor/package-summary.html index 6129e89..f0873ef 100644 --- a/docs/sdkapi/com/experian/datastudio/sdk/api/parser/processor/package-summary.html +++ b/docs/sdkapi/com/experian/datastudio/sdk/api/parser/processor/package-summary.html @@ -3,7 +3,7 @@ -com.experian.datastudio.sdk.api.parser.processor (SDKAPI 2.0.0 API) +com.experian.datastudio.sdk.api.parser.processor (SDKAPI 2.1.0 API) @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + +
    +
    com.experian.datastudio.sdk.api.step
    +

    Class CustomStepException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • com.experian.datastudio.sdk.api.step.CustomStepException
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      +
      public class CustomStepException
+extends java.lang.RuntimeException
      +
      Standard exception that will be thrown by custom step
      +
      +
      Since:
      +
      2.1.0
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + +
        Constructors 
        Constructor and Description
        CustomStepException(int errorCode, + java.lang.String message) +
        Constructs CustomStepException with error code and message.
        +
        CustomStepException(int errorCode, + java.lang.String message, + java.lang.Throwable cause) +
        Constructs CustomStepException with error code, message.
        +
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethod and Description
        intgetErrorCode() +
        Returns the customize error code to be displayed on Job details page
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CustomStepException

          +
          public CustomStepException(int errorCode,
+                           java.lang.String message)
          +
          Constructs CustomStepException with error code and message.
          +
          +
          Parameters:
          +
          errorCode - the customize error code to be displayed on Job details page
          +
          message - the message to be logged
          +
          +
          • +
        + + + +
          +
        • +

          CustomStepException

          +
          public CustomStepException(int errorCode,
+                           java.lang.String message,
+                           java.lang.Throwable cause)
          +
          Constructs CustomStepException with error code, message.
          +
          +
          Parameters:
          +
          errorCode - the customize error code to be displayed on Job details page
          +
          message - the message to be logged
          +
          cause - the cause
          +
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getErrorCode

          +
          public int getErrorCode()
          +
          Returns the customize error code to be displayed on Job details page
          +
          +
          Returns:
          +
          the customize error code
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + + diff --git a/docs/sdkapi/com/experian/datastudio/sdk/api/step/UserOption.html b/docs/sdkapi/com/experian/datastudio/sdk/api/step/UserOption.html index 0913380..dc85df3 100644 --- a/docs/sdkapi/com/experian/datastudio/sdk/api/step/UserOption.html +++ b/docs/sdkapi/com/experian/datastudio/sdk/api/step/UserOption.html @@ -3,7 +3,7 @@ -UserOption (SDKAPI 2.0.0 API) +UserOption (SDKAPI 2.1.0 API) @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,13 +11,13 @@ @@ -11,13 +11,13 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,13 +11,13 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + +
    +
    com.experian.datastudio.sdk.api.step.configuration
    +

    Enum StepSettingType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<StepSettingType>
        • +
      • +
          +
        • com.experian.datastudio.sdk.api.step.configuration.StepSettingType
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<StepSettingType>
      +
      +
      +
      +
      public enum StepSettingType
+extends java.lang.Enum<StepSettingType>
      +
      Predefined step setting types that can be applied to custom step .
      +
      +
      Since:
      +
      2.1.0
      +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + +
        Enum Constants 
        Enum Constant and Description
        PASSWORD 
        TEXT 
        TEXTAREA 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethod and Description
        static StepSettingTypevalueOf(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static StepSettingType[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + + + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static StepSettingType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (StepSettingType c : StepSettingType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static StepSettingType valueOf(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + +
    Skip navigation links
    + + + + +
    +
    + + + +
    + +
    +
    + + +
    + + +
    + + + diff --git a/docs/sdkapi/com/experian/datastudio/sdk/api/step/configuration/UICallbackContext.html b/docs/sdkapi/com/experian/datastudio/sdk/api/step/configuration/UICallbackContext.html index 6049bbb..57f6a90 100644 --- a/docs/sdkapi/com/experian/datastudio/sdk/api/step/configuration/UICallbackContext.html +++ b/docs/sdkapi/com/experian/datastudio/sdk/api/step/configuration/UICallbackContext.html @@ -3,7 +3,7 @@ -UICallbackContext (SDKAPI 2.0.0 API) +UICallbackContext (SDKAPI 2.1.0 API) @@ -11,13 +11,13 @@ @@ -50,6 +50,7 @@

    Enums

    diff --git a/docs/sdkapi/com/experian/datastudio/sdk/api/step/configuration/package-summary.html b/docs/sdkapi/com/experian/datastudio/sdk/api/step/configuration/package-summary.html index d97a9fd..d3cff0e 100644 --- a/docs/sdkapi/com/experian/datastudio/sdk/api/step/configuration/package-summary.html +++ b/docs/sdkapi/com/experian/datastudio/sdk/api/step/configuration/package-summary.html @@ -3,7 +3,7 @@ -com.experian.datastudio.sdk.api.step.configuration (SDKAPI 2.0.0 API) +com.experian.datastudio.sdk.api.step.configuration (SDKAPI 2.1.0 API) @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ diff --git a/docs/sdkapi/com/experian/datastudio/sdk/api/step/configuration/stepproperties/package-summary.html b/docs/sdkapi/com/experian/datastudio/sdk/api/step/configuration/stepproperties/package-summary.html index 17a5683..9ef55b4 100644 --- a/docs/sdkapi/com/experian/datastudio/sdk/api/step/configuration/stepproperties/package-summary.html +++ b/docs/sdkapi/com/experian/datastudio/sdk/api/step/configuration/stepproperties/package-summary.html @@ -3,7 +3,7 @@ -com.experian.datastudio.sdk.api.step.configuration.stepproperties (SDKAPI 2.0.0 API) +com.experian.datastudio.sdk.api.step.configuration.stepproperties (SDKAPI 2.1.0 API) @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -16,6 +16,10 @@

    Interfaces

  • CustomStepDefinition
  • UserOption
    • +

    Exceptions

    + diff --git a/docs/sdkapi/com/experian/datastudio/sdk/api/step/package-summary.html b/docs/sdkapi/com/experian/datastudio/sdk/api/step/package-summary.html index 16b0697..b7bd545 100644 --- a/docs/sdkapi/com/experian/datastudio/sdk/api/step/package-summary.html +++ b/docs/sdkapi/com/experian/datastudio/sdk/api/step/package-summary.html @@ -3,7 +3,7 @@ -com.experian.datastudio.sdk.api.step (SDKAPI 2.0.0 API) +com.experian.datastudio.sdk.api.step (SDKAPI 2.1.0 API) @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ diff --git a/docs/sdkapi/com/experian/datastudio/sdk/api/step/processor/cache/package-summary.html b/docs/sdkapi/com/experian/datastudio/sdk/api/step/processor/cache/package-summary.html index a18e30d..56f439c 100644 --- a/docs/sdkapi/com/experian/datastudio/sdk/api/step/processor/cache/package-summary.html +++ b/docs/sdkapi/com/experian/datastudio/sdk/api/step/processor/cache/package-summary.html @@ -3,7 +3,7 @@ -com.experian.datastudio.sdk.api.step.processor.cache (SDKAPI 2.0.0 API) +com.experian.datastudio.sdk.api.step.processor.cache (SDKAPI 2.1.0 API) @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ diff --git a/docs/sdkapi/com/experian/datastudio/sdk/api/step/processor/package-summary.html b/docs/sdkapi/com/experian/datastudio/sdk/api/step/processor/package-summary.html index fc579fc..1c8e51d 100644 --- a/docs/sdkapi/com/experian/datastudio/sdk/api/step/processor/package-summary.html +++ b/docs/sdkapi/com/experian/datastudio/sdk/api/step/processor/package-summary.html @@ -3,7 +3,7 @@ -com.experian.datastudio.sdk.api.step.processor (SDKAPI 2.0.0 API) +com.experian.datastudio.sdk.api.step.processor (SDKAPI 2.1.0 API) @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ diff --git a/docs/sdkapi/overview-summary.html b/docs/sdkapi/overview-summary.html index 2429cb7..f2c4fa8 100644 --- a/docs/sdkapi/overview-summary.html +++ b/docs/sdkapi/overview-summary.html @@ -3,7 +3,7 @@ -Overview (SDKAPI 2.0.0 API) +Overview (SDKAPI 2.1.0 API) @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ + + + + + +
    + + +
    Skip navigation links
    + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + +
    +

    Serialized Form

    +
    +
    + +
    + +
    + + +
    Skip navigation links
    + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + + + diff --git a/docs/sdklib/allclasses-frame.html b/docs/sdklib/allclasses-frame.html index e5b5815..216cef9 100644 --- a/docs/sdklib/allclasses-frame.html +++ b/docs/sdklib/allclasses-frame.html @@ -3,7 +3,7 @@ -All Classes (SDKLIB 2.0.0 API) +All Classes (SDKLIB 2.1.0 API) diff --git a/docs/sdklib/allclasses-noframe.html b/docs/sdklib/allclasses-noframe.html index 8496959..299ddd5 100644 --- a/docs/sdklib/allclasses-noframe.html +++ b/docs/sdklib/allclasses-noframe.html @@ -3,7 +3,7 @@ -All Classes (SDKLIB 2.0.0 API) +All Classes (SDKLIB 2.1.0 API) diff --git a/docs/sdklib/com/experian/datastudio/sdk/lib/logging/SdkLogManager.html b/docs/sdklib/com/experian/datastudio/sdk/lib/logging/SdkLogManager.html index 6bb4e20..6101233 100644 --- a/docs/sdklib/com/experian/datastudio/sdk/lib/logging/SdkLogManager.html +++ b/docs/sdklib/com/experian/datastudio/sdk/lib/logging/SdkLogManager.html @@ -3,7 +3,7 @@ -SdkLogManager (SDKLIB 2.0.0 API) +SdkLogManager (SDKLIB 2.1.0 API) @@ -11,7 +11,7 @@ diff --git a/docs/sdklib/com/experian/datastudio/sdk/lib/logging/package-summary.html b/docs/sdklib/com/experian/datastudio/sdk/lib/logging/package-summary.html index 27431cd..42ce1eb 100644 --- a/docs/sdklib/com/experian/datastudio/sdk/lib/logging/package-summary.html +++ b/docs/sdklib/com/experian/datastudio/sdk/lib/logging/package-summary.html @@ -3,7 +3,7 @@ -com.experian.datastudio.sdk.lib.logging (SDKLIB 2.0.0 API) +com.experian.datastudio.sdk.lib.logging (SDKLIB 2.1.0 API) @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ diff --git a/docs/sdklib/com/experian/datastudio/sdk/lib/web/package-summary.html b/docs/sdklib/com/experian/datastudio/sdk/lib/web/package-summary.html index 90ee9cd..b9ed7ac 100644 --- a/docs/sdklib/com/experian/datastudio/sdk/lib/web/package-summary.html +++ b/docs/sdklib/com/experian/datastudio/sdk/lib/web/package-summary.html @@ -3,7 +3,7 @@ -com.experian.datastudio.sdk.lib.web (SDKLIB 2.0.0 API) +com.experian.datastudio.sdk.lib.web (SDKLIB 2.1.0 API) @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@ diff --git a/docs/sdklib/overview-summary.html b/docs/sdklib/overview-summary.html index 8b9984c..1702db5 100644 --- a/docs/sdklib/overview-summary.html +++ b/docs/sdklib/overview-summary.html @@ -3,7 +3,7 @@ -Overview (SDKLIB 2.0.0 API) +Overview (SDKLIB 2.1.0 API) @@ -11,7 +11,7 @@ @@ -11,7 +11,7 @@