smart_city v5.0.2 SmartCity.Dataset.Technical View Source
A struct defining technical metadata on a dataset.
Link to this section Summary
Functions
Returns a new SmartCity.Dataset.Technical
.
Can be created from Map
with string or atom keys.
Raises an ArgumentError
when passed invalid input
Link to this section Types
Link to this type
t()
View Sourcet() :: %SmartCity.Dataset.Technical{ dataName: String.t(), orgId: not_required(String.t()), orgName: String.t(), private: not_required(boolean()), protocol: not_required([String.t()]), schema: not_required([map()]), sourceHeaders: not_required(map()), sourceQueryParams: not_required(map()), sourceType: not_required(String.t()), sourceUrl: String.t(), systemName: String.t() }
Link to this section Functions
Returns a new SmartCity.Dataset.Technical
.
Can be created from Map
with string or atom keys.
Raises an ArgumentError
when passed invalid input
Parameters
msg: Map with string or atom keys that defines the dataset's technical metadata
Required Keys
- dataName
- orgName
- systemName
- sourceUrl
sourceType will default to "remote"