Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DataBrew.Types.ExcelOptions

Description

Synopsis

data ExcelOptions = ExcelOptions' {
- sheetIndexes :: Maybe (NonEmpty Natural)
- sheetNames :: Maybe (NonEmpty Text)
- headerRow :: Maybe Bool
}
newExcelOptions :: ExcelOptions
excelOptions_sheetIndexes :: Lens' ExcelOptions (Maybe (NonEmpty Natural))
excelOptions_sheetNames :: Lens' ExcelOptions (Maybe (NonEmpty Text))
excelOptions_headerRow :: Lens' ExcelOptions (Maybe Bool)

Documentation

data ExcelOptions Source #

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

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.
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.

Instances

Instances details

Eq ExcelOptions Source #
Instance details Defined in Amazonka.DataBrew.Types.ExcelOptions Methods (==) :: ExcelOptions -> ExcelOptions -> Bool # (/=) :: ExcelOptions -> ExcelOptions -> Bool #
Read ExcelOptions Source #
Instance details Defined in Amazonka.DataBrew.Types.ExcelOptions Methods readsPrec :: Int -> ReadS ExcelOptions # readList :: ReadS [ExcelOptions] # readPrec :: ReadPrec ExcelOptions # readListPrec :: ReadPrec [ExcelOptions] #
Show ExcelOptions Source #
Instance details Defined in Amazonka.DataBrew.Types.ExcelOptions Methods showsPrec :: Int -> ExcelOptions -> ShowS # show :: ExcelOptions -> String # showList :: [ExcelOptions] -> ShowS #
Generic ExcelOptions Source #
Instance details Defined in Amazonka.DataBrew.Types.ExcelOptions Associated Types type Rep ExcelOptions :: Type -> Type # Methods from :: ExcelOptions -> Rep ExcelOptions x # to :: Rep ExcelOptions x -> ExcelOptions #
NFData ExcelOptions Source #
Instance details Defined in Amazonka.DataBrew.Types.ExcelOptions Methods rnf :: ExcelOptions -> () #
Hashable ExcelOptions Source #
Instance details Defined in Amazonka.DataBrew.Types.ExcelOptions Methods hashWithSalt :: Int -> ExcelOptions -> Int # hash :: ExcelOptions -> Int #
ToJSON ExcelOptions Source #
Instance details Defined in Amazonka.DataBrew.Types.ExcelOptions Methods toJSON :: ExcelOptions -> Value # toEncoding :: ExcelOptions -> Encoding # toJSONList :: [ExcelOptions] -> Value # toEncodingList :: [ExcelOptions] -> Encoding #
FromJSON ExcelOptions Source #
Instance details Defined in Amazonka.DataBrew.Types.ExcelOptions Methods parseJSON :: Value -> Parser ExcelOptions # parseJSONList :: Value -> Parser [ExcelOptions] #
type Rep ExcelOptions Source #
Instance details Defined in Amazonka.DataBrew.Types.ExcelOptions type Rep ExcelOptions = D1 ('MetaData "ExcelOptions" "Amazonka.DataBrew.Types.ExcelOptions" "libZSservicesZSamazonka-databrewZSamazonka-databrew" 'False) (C1 ('MetaCons "ExcelOptions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sheetIndexes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Natural))) :: (S1 ('MetaSel ('Just "sheetNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: S1 ('MetaSel ('Just "headerRow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newExcelOptions :: ExcelOptions Source #

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: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.

$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.

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

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

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

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

excelOptions_headerRow :: Lens' ExcelOptions (Maybe Bool) Source #

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.