View Source SmartCity.Dataset.Business (smart_city v6.0.0)
A struct representing the business data portion of a dataset struct definition (represented by SmartCity.Dataset)
You probably won't need to access this module directly; SmartCity.Dataset.new/1 will build this for you
Link to this section Summary
Functions
Returns a new SmartCity.Dataset.Business struct.
Can be created from Map with string or atom keys.
Link to this section Types
@type license_or_default() :: String.t()
@type not_required() :: term() | nil
@type t() :: %SmartCity.Dataset.Business{ authorEmail: not_required(), authorName: not_required(), benefitRating: not_required(), categories: not_required(), conformsToUri: not_required(), contactEmail: String.t(), contactName: String.t(), dataTitle: String.t(), describedByMimeType: not_required(), describedByUrl: not_required(), description: String.t(), homepage: not_required(), issuedDate: not_required(), keywords: not_required(), language: not_required(), license: license_or_default(), modifiedDate: String.t(), orgTitle: String.t(), parentDataset: not_required(), publishFrequency: not_required(), referenceUrls: not_required(), rights: not_required(), riskRating: not_required(), spatial: not_required(), temporal: not_required() }
Link to this section Functions
Returns a new SmartCity.Dataset.Business struct.
Can be created from Map with string or atom keys.
parameters
Parameters
- msg: Map with string or atom keys that defines the dataset's business metadata. See
SmartCity.Dataset.Businesstypespec for available keys.
Required Keys
- dataTitle
- description
- modifiedDate
- orgTitle
- contactName
- contactEmail- License will default to http://opendefinition.org/licenses/cc-by/ if not provided