smart_city v3.2.4 SmartCity.Event View Source

Defines macros for encoding event types the Smart City platform will respond to in any of the various micro service components in a central location shared by all components.

Link to this section Summary

Functions

Signals a dataset has completed the extraction process and the final message has been written to the raw ingestion topic.

Signals data for a dataset is about to be downloaded into the platform, parsed, and written to the raw ingestion topic.

Signals a dataset has completed an ingestion process through the pipeline from end to end and been persisted.

Signals a dataset is about to be retrieved and begin loading into the ingestion pipeline.

Signals that data standardization is complete

Signals that a dataset should be deleted

Signals that a dataset should be disabled.

Signals that dataset extraction has completed

Signals that a dataset extraction is starting

Defines an update event to a dataset within the system. The system treats create events as a subset of updates.

Declares an error occurred during an attempted data extraction.

Declares an error occurred during an attempted data ingestion.

Declares an error occurred during the attempted upsert of a dataset.

Declares an error occurred during an attempted file ingestion.

Declares an error occurred during the attempted upsert of an organization.

Signals a non-ingestable data file has been successfully uploaded to the object store bucket.

Signals a non-ingestable data file is about to be downloaded to the platform and stored in the object store bucket.

file_upload() deprecated

Signals that a new file has been uploaded to the object store and made available for the rest of the system.

Hosted file and been downloaded and stored

hosted_file_start() deprecated

Signals to file should be downloaded

Defines an update event to an organization within the system. The system treats create events as a subset of updates.

Defines a user organization relationship.

Link to this section Functions

Link to this macro

data_extract_end()

View Source (macro)

Signals a dataset has completed the extraction process and the final message has been written to the raw ingestion topic.

Link to this macro

data_extract_start()

View Source (macro)

Signals data for a dataset is about to be downloaded into the platform, parsed, and written to the raw ingestion topic.

Link to this macro

data_ingest_end()

View Source (macro)

Signals a dataset has completed an ingestion process through the pipeline from end to end and been persisted.

Link to this macro

data_ingest_start()

View Source (macro)

Signals a dataset is about to be retrieved and begin loading into the ingestion pipeline.

Link to this macro

data_standardization_end()

View Source (macro)

Signals that data standardization is complete

Link to this macro

dataset_delete()

View Source (macro)

Signals that a dataset should be deleted

Link to this macro

dataset_disable()

View Source (macro)

Signals that a dataset should be disabled.

Link to this macro

dataset_extract_complete()

View Source (macro)
This macro is deprecated. Use data_extract_end/0.

Signals that dataset extraction has completed

Link to this macro

dataset_extract_start()

View Source (macro)
This macro is deprecated. Use data_extract_start/0.

Signals that a dataset extraction is starting

Link to this macro

dataset_update()

View Source (macro)

Defines an update event to a dataset within the system. The system treats create events as a subset of updates.

Link to this macro

error_data_extract()

View Source (macro)

Declares an error occurred during an attempted data extraction.

Link to this macro

error_data_ingest()

View Source (macro)

Declares an error occurred during an attempted data ingestion.

Link to this macro

error_dataset_update()

View Source (macro)

Declares an error occurred during the attempted upsert of a dataset.

Link to this macro

error_file_ingest()

View Source (macro)

Declares an error occurred during an attempted file ingestion.

Link to this macro

error_organization_update()

View Source (macro)

Declares an error occurred during the attempted upsert of an organization.

Link to this macro

file_ingest_end()

View Source (macro)

Signals a non-ingestable data file has been successfully uploaded to the object store bucket.

Link to this macro

file_ingest_start()

View Source (macro)

Signals a non-ingestable data file is about to be downloaded to the platform and stored in the object store bucket.

This macro is deprecated. Use file_ingest_end/0.

Signals that a new file has been uploaded to the object store and made available for the rest of the system.

Link to this macro

hosted_file_complete()

View Source (macro)
This macro is deprecated. Use file_ingest_end/0.

Hosted file and been downloaded and stored

Link to this macro

hosted_file_start()

View Source (macro)
This macro is deprecated. Use file_ingest_start/0.

Signals to file should be downloaded

Link to this macro

organization_update()

View Source (macro)

Defines an update event to an organization within the system. The system treats create events as a subset of updates.

Link to this macro

user_organization_associate()

View Source (macro)

Defines a user organization relationship.