Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.QuickSight.Types.DateDimensionField

Description

Documentation

data DateDimensionField Source #

The dimension type field with date type columns.

See: newDateDimensionField smart constructor.

Constructors

DateDimensionField'

Fields

dateGranularity :: Maybe TimeGranularity
The date granularity of the DateDimensionField. Choose one of the following options:
- ```
YEAR
```
- ```
QUARTER
```
- ```
MONTH
```
- ```
WEEK
```
- ```
DAY
```
- ```
HOUR
```
- ```
MINUTE
```
- ```
SECOND
```
- ```
MILLISECOND
```
formatConfiguration :: Maybe DateTimeFormatConfiguration
The format configuration of the field.
hierarchyId :: Maybe Text
The custom hierarchy ID.
fieldId :: Text
The custom field ID.
column :: ColumnIdentifier
The column that is used in the DateDimensionField.

Instances

Instances details

FromJSON DateDimensionField Source #
Instance details Defined in Amazonka.QuickSight.Types.DateDimensionField Methods parseJSON :: Value -> Parser DateDimensionField # parseJSONList :: Value -> Parser [DateDimensionField] #
ToJSON DateDimensionField Source #
Instance details Defined in Amazonka.QuickSight.Types.DateDimensionField Methods toJSON :: DateDimensionField -> Value # toEncoding :: DateDimensionField -> Encoding # toJSONList :: [DateDimensionField] -> Value # toEncodingList :: [DateDimensionField] -> Encoding #
Generic DateDimensionField Source #
Instance details Defined in Amazonka.QuickSight.Types.DateDimensionField Associated Types type Rep DateDimensionField :: Type -> Type # Methods from :: DateDimensionField -> Rep DateDimensionField x # to :: Rep DateDimensionField x -> DateDimensionField #
Show DateDimensionField Source #
Instance details Defined in Amazonka.QuickSight.Types.DateDimensionField Methods showsPrec :: Int -> DateDimensionField -> ShowS # show :: DateDimensionField -> String # showList :: [DateDimensionField] -> ShowS #
NFData DateDimensionField Source #
Instance details Defined in Amazonka.QuickSight.Types.DateDimensionField Methods rnf :: DateDimensionField -> () #
Eq DateDimensionField Source #
Instance details Defined in Amazonka.QuickSight.Types.DateDimensionField Methods (==) :: DateDimensionField -> DateDimensionField -> Bool # (/=) :: DateDimensionField -> DateDimensionField -> Bool #
Hashable DateDimensionField Source #
Instance details Defined in Amazonka.QuickSight.Types.DateDimensionField Methods hashWithSalt :: Int -> DateDimensionField -> Int # hash :: DateDimensionField -> Int #
type Rep DateDimensionField Source #
Instance details Defined in Amazonka.QuickSight.Types.DateDimensionField type Rep DateDimensionField = D1 ('MetaData "DateDimensionField" "Amazonka.QuickSight.Types.DateDimensionField" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "DateDimensionField'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dateGranularity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeGranularity)) :: S1 ('MetaSel ('Just "formatConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DateTimeFormatConfiguration))) :: (S1 ('MetaSel ('Just "hierarchyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "fieldId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "column") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ColumnIdentifier)))))

newDateDimensionField Source #

Arguments

:: Text	`$sel:fieldId:DateDimensionField'`
-> ColumnIdentifier	`$sel:column:DateDimensionField'`
-> DateDimensionField

Create a value of DateDimensionField 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:dateGranularity:DateDimensionField', dateDimensionField_dateGranularity - The date granularity of the DateDimensionField. Choose one of the following options:

```
YEAR
```
```
QUARTER
```
```
MONTH
```
```
WEEK
```
```
DAY
```
```
HOUR
```
```
MINUTE
```
```
SECOND
```
```
MILLISECOND
```

$sel:formatConfiguration:DateDimensionField', dateDimensionField_formatConfiguration - The format configuration of the field.

$sel:hierarchyId:DateDimensionField', dateDimensionField_hierarchyId - The custom hierarchy ID.

$sel:fieldId:DateDimensionField', dateDimensionField_fieldId - The custom field ID.

$sel:column:DateDimensionField', dateDimensionField_column - The column that is used in the DateDimensionField.

dateDimensionField_dateGranularity :: Lens' DateDimensionField (Maybe TimeGranularity) Source #

The date granularity of the DateDimensionField. Choose one of the following options:

```
YEAR
```
```
QUARTER
```
```
MONTH
```
```
WEEK
```
```
DAY
```
```
HOUR
```
```
MINUTE
```
```
SECOND
```
```
MILLISECOND
```

dateDimensionField_formatConfiguration :: Lens' DateDimensionField (Maybe DateTimeFormatConfiguration) Source #

The format configuration of the field.

dateDimensionField_hierarchyId :: Lens' DateDimensionField (Maybe Text) Source #

The custom hierarchy ID.

dateDimensionField_fieldId :: Lens' DateDimensionField Text Source #

The custom field ID.

dateDimensionField_column :: Lens' DateDimensionField ColumnIdentifier Source #

The column that is used in the DateDimensionField.