software.amazon.awscdk.services.databrew

Interface CfnDataset.ExcelOptionsProperty

All Known Implementing Classes:

CfnDataset.ExcelOptionsProperty.Jsii$Proxy

Enclosing class:

CfnDataset

public static interface CfnDataset.ExcelOptionsProperty

Represents a set of options that define how DataBrew will interpret a Microsoft Excel file when creating a dataset from that file.

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.databrew.*;
 ExcelOptionsProperty excelOptionsProperty = ExcelOptionsProperty.builder()
         .headerRow(false)
         .sheetIndexes(List.of(123))
         .sheetNames(List.of("sheetNames"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDataset.ExcelOptionsProperty.Builder A builder for CfnDataset.ExcelOptionsProperty
static class	CfnDataset.ExcelOptionsProperty.Jsii$Proxy An implementation for CfnDataset.ExcelOptionsProperty

Method Summary

Modifier and Type	Method and Description
static CfnDataset.ExcelOptionsProperty.Builder	builder()
default java.lang.Object	getHeaderRow() A variable that specifies whether the first row in the file is parsed as the header.
default java.lang.Object	getSheetIndexes() One or more sheet numbers in the Excel file that will be included in the dataset.
default java.util.List<java.lang.String>	getSheetNames() One or more named sheets in the Excel file that will be included in the dataset.

Method Detail

getHeaderRow

default java.lang.Object getHeaderRow()

A variable that specifies whether the first row in the file is parsed as the header.

If this value is false, column names are auto-generated.

getSheetIndexes

default java.lang.Object getSheetIndexes()

One or more sheet numbers in the Excel file that will be included in the dataset.

getSheetNames

default java.util.List<java.lang.String> getSheetNames()

One or more named sheets in the Excel file that will be included in the dataset.

builder

static CfnDataset.ExcelOptionsProperty.Builder builder()

Returns:

a CfnDataset.ExcelOptionsProperty.Builder of CfnDataset.ExcelOptionsProperty