Package software.amazon.awscdk.services.databrew

Interface CfnDataset.ExcelOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataset.ExcelOptionsProperty.Jsii$Proxy

Enclosing class:

CfnDataset

@Stability(Stable)
public static interface CfnDataset.ExcelOptionsProperty
extends software.amazon.jsii.JsiiSerializable

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-exceloptions.html

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHeaderRow

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-exceloptions.html#cfn-databrew-dataset-exceloptions-headerrow

getSheetIndexes

@Stability(Stable)
@Nullable
default Object getSheetIndexes()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-exceloptions.html#cfn-databrew-dataset-exceloptions-sheetindexes

getSheetNames

@Stability(Stable)
@Nullable
default List<String> getSheetNames()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-dataset-exceloptions.html#cfn-databrew-dataset-exceloptions-sheetnames

builder

@Stability(Stable)
static CfnDataset.ExcelOptionsProperty.Builder builder()

Returns:

a CfnDataset.ExcelOptionsProperty.Builder of CfnDataset.ExcelOptionsProperty