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

Description

Documentation

data DatasetParameter Source #

Represents a dataset paramater that defines type and conditions for a parameter in the Amazon S3 path of the dataset.

See: newDatasetParameter smart constructor.

Constructors

DatasetParameter'

Fields

createColumn :: Maybe Bool
Optional boolean value that defines whether the captured value of this parameter should be used to create a new column in a dataset.
filter' :: Maybe FilterExpression
The optional filter expression structure to apply additional matching criteria to the parameter.
datetimeOptions :: Maybe DatetimeOptions
Additional parameter options such as a format and a timezone. Required for datetime parameters.
name :: Text
The name of the parameter that is used in the dataset's Amazon S3 path.
type' :: ParameterType
The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.

Instances

Instances details

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

newDatasetParameter Source #

Arguments

:: Text	`$sel:name:DatasetParameter'`
-> ParameterType	`$sel:type':DatasetParameter'`
-> DatasetParameter

Create a value of DatasetParameter 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:createColumn:DatasetParameter', datasetParameter_createColumn - Optional boolean value that defines whether the captured value of this parameter should be used to create a new column in a dataset.

$sel:filter':DatasetParameter', datasetParameter_filter - The optional filter expression structure to apply additional matching criteria to the parameter.

$sel:datetimeOptions:DatasetParameter', datasetParameter_datetimeOptions - Additional parameter options such as a format and a timezone. Required for datetime parameters.

$sel:name:DatasetParameter', datasetParameter_name - The name of the parameter that is used in the dataset's Amazon S3 path.

$sel:type':DatasetParameter', datasetParameter_type - The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.

datasetParameter_createColumn :: Lens' DatasetParameter (Maybe Bool) Source #

Optional boolean value that defines whether the captured value of this parameter should be used to create a new column in a dataset.

datasetParameter_filter :: Lens' DatasetParameter (Maybe FilterExpression) Source #

The optional filter expression structure to apply additional matching criteria to the parameter.

datasetParameter_datetimeOptions :: Lens' DatasetParameter (Maybe DatetimeOptions) Source #

Additional parameter options such as a format and a timezone. Required for datetime parameters.

datasetParameter_name :: Lens' DatasetParameter Text Source #

The name of the parameter that is used in the dataset's Amazon S3 path.

datasetParameter_type :: Lens' DatasetParameter ParameterType Source #

The type of the dataset parameter, can be one of a 'String', 'Number' or 'Datetime'.