Package software.amazon.awscdk.services.stepfunctions

Class CsvHeaders

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.stepfunctions.CsvHeaders
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:14.360Z") @Stability(Stable) public class CsvHeaders extends software.amazon.jsii.JsiiObject
Configuration for CSV header options for a CSV Item Reader.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.stepfunctions.*;
 CsvHeaders csvHeaders = CsvHeaders.use(List.of("headers"));

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    CsvHeaders(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    CsvHeaders(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    CsvHeaderLocation
    getHeaderLocation()
    Location of headers in CSV file.
    List<String>
    getHeaders()
    List of headers if headerLocation is GIVEN.
    static CsvHeaders
    use(List<String> headers)
    Configures S3CsvItemReader to use the headers provided in the headers parameter.
    static CsvHeaders
    useFirstRow()
    Configures S3CsvItemReader to read headers from the first row of the CSV file.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • CsvHeaders

      protected CsvHeaders(software.amazon.jsii.JsiiObjectRef objRef)

    • CsvHeaders

      protected CsvHeaders(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

  • Method Details

    • use

      @Stability(Stable) @NotNull public static CsvHeaders use(@NotNull List<String> headers)
      Configures S3CsvItemReader to use the headers provided in the headers parameter.

      Parameters:
      headers -
      • List of headers.
      This parameter is required.
      Returns:
      • CsvHeaders

    • useFirstRow

      @Stability(Stable) @NotNull public static CsvHeaders useFirstRow()
      Configures S3CsvItemReader to read headers from the first row of the CSV file.

      Returns:
      • CsvHeaders

    • getHeaderLocation

      @Stability(Stable) @NotNull public CsvHeaderLocation getHeaderLocation()
      Location of headers in CSV file.

    • getHeaders

      @Stability(Stable) @Nullable public List<String> getHeaders()
      List of headers if headerLocation is GIVEN.