smart_city v3.5.1 SmartCity.Dataset.Technical View Source

A struct defining technical metadata on a dataset.

Link to this section Summary

Types

t()

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

not_required(type)

not_required(type) :: type | nil

t()

t() :: %SmartCity.Dataset.Technical{
  allow_duplicates: not_required(boolean()),
  authHeaders: not_required(map()),
  authUrl: String.t(),
  cadence: not_required(String.t()),
  credentials: boolean(),
  dataName: String.t(),
  orgId: not_required(String.t()),
  orgName: String.t(),
  private: not_required(boolean()),
  protocol: not_required([String.t()]),
  schema: not_required([map()]),
  sourceFormat: String.t(),
  sourceHeaders: not_required(map()),
  sourceQueryParams: not_required(map()),
  sourceType: not_required(String.t()),
  sourceUrl: String.t(),
  systemName: String.t()
}

Link to this section Functions

new(msg)

new(map()) :: SmartCity.Dataset.Technical.t()

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
- sourceFormat
sourceType will default to "remote"
cadence will default to "never"