Amazonka.DataBrew.Types.ExcelOptions

Documentation

data ExcelOptions

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

See: newExcelOptions smart constructor.

Constructors

ExcelOptions'

Fields

• headerRow :: Maybe Bool

  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.

• sheetIndexes :: Maybe (NonEmpty Natural)

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

• sheetNames :: Maybe (NonEmpty Text)

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

Instances

FromJSON ExcelOptions

Defined in Amazonka.DataBrew.Types.ExcelOptions

Methods

parseJSON :: Value -> Parser ExcelOptions

parseJSONList :: Value -> Parser [ExcelOptions]

ToJSON ExcelOptions

Defined in Amazonka.DataBrew.Types.ExcelOptions

Methods

toJSON :: ExcelOptions -> Value

toEncoding :: ExcelOptions -> Encoding

toJSONList :: [ExcelOptions] -> Value

toEncodingList :: [ExcelOptions] -> Encoding

Generic ExcelOptions

Defined in Amazonka.DataBrew.Types.ExcelOptions

Associated Types

type Rep ExcelOptions :: Type -> Type

Methods

from :: ExcelOptions -> Rep ExcelOptions x

to :: Rep ExcelOptions x -> ExcelOptions

Read ExcelOptions

Defined in Amazonka.DataBrew.Types.ExcelOptions

Methods

readsPrec :: Int -> ReadS ExcelOptions

readList :: ReadS [ExcelOptions]

readPrec :: ReadPrec ExcelOptions

readListPrec :: ReadPrec [ExcelOptions]

Show ExcelOptions

Defined in Amazonka.DataBrew.Types.ExcelOptions

Methods

showsPrec :: Int -> ExcelOptions -> ShowS

show :: ExcelOptions -> String

showList :: [ExcelOptions] -> ShowS

NFData ExcelOptions

Defined in Amazonka.DataBrew.Types.ExcelOptions

Methods

rnf :: ExcelOptions -> ()

Eq ExcelOptions

Defined in Amazonka.DataBrew.Types.ExcelOptions

Methods

(==) :: ExcelOptions -> ExcelOptions -> Bool

(/=) :: ExcelOptions -> ExcelOptions -> Bool

Hashable ExcelOptions

Defined in Amazonka.DataBrew.Types.ExcelOptions

Methods

hashWithSalt :: Int -> ExcelOptions -> Int

hash :: ExcelOptions -> Int

type Rep ExcelOptions

Defined in Amazonka.DataBrew.Types.ExcelOptions

type Rep ExcelOptions = D1 ('MetaData "ExcelOptions" "Amazonka.DataBrew.Types.ExcelOptions" "amazonka-databrew-2.0-GJMXoRzRb387Yq6XNY29RM" 'False) (C1 ('MetaCons "ExcelOptions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "headerRow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "sheetIndexes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Natural))) :*: S1 ('MetaSel ('Just "sheetNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))))))

newExcelOptions :: ExcelOptions

Create a value of ExcelOptions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:headerRow:ExcelOptions', excelOptions_headerRow - 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.

$sel:sheetIndexes:ExcelOptions', excelOptions_sheetIndexes - One or more sheet numbers in the Excel file that will be included in the dataset.

$sel:sheetNames:ExcelOptions', excelOptions_sheetNames - One or more named sheets in the Excel file that will be included in the dataset.

excelOptions_headerRow :: Lens' ExcelOptions (Maybe Bool)

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.

excelOptions_sheetIndexes :: Lens' ExcelOptions (Maybe (NonEmpty Natural))

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

excelOptions_sheetNames :: Lens' ExcelOptions (Maybe (NonEmpty Text))

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