smart_city
v6.0.0

View Source SmartCity.Dataset.Technical (smart_city v6.0.0)

A struct defining technical metadata on a dataset.

Link to this section Summary

Types

not_required(type)
t()

Functions

delete(struct, key)
get(struct, key, default \\ nil)
new(msg)

Returns a new SmartCity.Dataset.Technical. Can be created from Map with string or atom keys. Raises an ArgumentError when passed invalid input

put(struct, key, val)

Link to this section Types

Link to this type

not_required(type)

View Source 
@type not_required(type) :: type | nil
Link to this type

t()

View Source 
@type t() :: %SmartCity.Dataset.Technical{
  allow_duplicates: not_required(boolean()),
  authBody: not_required(map()),
  authBodyEncodeMethod: not_required(String.t()),
  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()]),
  sourceHeaders: not_required(map()),
  sourceQueryParams: not_required(map()),
  sourceType: not_required(String.t()),
  sourceUrl: String.t(),
  systemName: String.t(),
  topLevelSelector: not_required(String.t())
}

Link to this section Functions

Link to this function

delete(struct, key)

View Source
Link to this function

get(struct, key, default \\ nil)

View Source
Link to this function

new(msg)

View Source 
@spec new(map()) :: 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

 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"
Link to this function

put(struct, key, val)

View Source