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 |
Documentation
data SchemaAttribute Source #
An attribute of a schema, which defines a dataset field. A schema
attribute is required for every field in a dataset. The
Schema
object contains an array of SchemaAttribute
objects.
See: newSchemaAttribute
smart constructor.
SchemaAttribute' | |
|
Instances
newSchemaAttribute :: SchemaAttribute Source #
Create a value of SchemaAttribute
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:attributeName:SchemaAttribute'
, schemaAttribute_attributeName
- The name of the dataset field.
$sel:attributeType:SchemaAttribute'
, schemaAttribute_attributeType
- The data type of the field.
For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).
schemaAttribute_attributeName :: Lens' SchemaAttribute (Maybe Text) Source #
The name of the dataset field.
schemaAttribute_attributeType :: Lens' SchemaAttribute (Maybe AttributeType) Source #
The data type of the field.
For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).