arcgis.realtime module¶

The arcgis.velocity module provides API functions mapping to automate the ArcGIS Veloicty REST API. ArcGIS Velocity is a real-time and big data processing and analysis capability of ArcGIS Online. It enables you to ingest, visualize, analyze, store, and act upon data from Internet of Things (IoT) sensors.

The arcgis.realtime.StreamLayer provides types and functions for receiving real-time data feeds and sensor data streamed from the GIS to perform continuous processing and analysis. It includes support for stream layers that allow Python scripts to subscribe to the streamed feature data or broadcast updates or alerts.

StreamLayer¶

class arcgis.realtime.StreamLayer(url, gis=None)¶

Stream layers allow Python scripts to subscribe to the feature data streamed from the GIS using the GeoEvent Processor or broadcast updates or alerts. This class can be used to perform continuous processing and analysis of real-time data as it’s received.

property filter¶: Property used for filtering the streamed features so they meet spatial and SQL like criteria, and return the specified fields

property out_sr¶: The spatial reference of the streamed features

subscribe(on_features, on_open=None, on_disconnect=None, on_error=None)¶: Allows Python scripts to subscribe to the feature data streamed from the GIS using the GeoEvent Processor. Subscribing to the streamed data can be used to perform continuous processing and analysis of real-time data as it’s received. :param on_features: callback function that is called every time features are streamed to the client :param on_open: callback function called when the connection to the streaming server is created :param on_disconnect: callback function called when the connection to the streaming server is closed :param on_error: callback function called if the connection recieves an error

Velocity¶

class arcgis.realtime.Velocity(url, gis)¶

property bigdata_analytics¶

Provides access to the resource manager for managing configured Big data analytics tasks with ArcGIS Velocity. See BigDataAnalyticsManager.

Returns: bigdata_analytics

property feeds¶

Provides access to the resource manager for managing configured Feeds with ArcGIS Velocity. See FeedsManager.

Returns: feeds

property realtime_analytics¶

Provides access to the resource manager for managing configured Real-time analytics tasks with ArcGIS Velocity. See RealTimeAnalyticsManager.

Returns: realtime_analytics

FeedsManager¶

class arcgis.realtime.velocity.FeedsManager(url, gis)¶

Used to manage Feeds

get(id)¶: Get Feed by id :param id: unique id of a Feed :return: endpoint response of Feed for the given id

property items¶: Get all Feeds :return: returns a collection of all configured Feed tasks

RealTimeAnalyticsManager¶

class arcgis.realtime.velocity.RealTimeAnalyticsManager(url, gis)¶

Used to manage Real-Time Analytics

get(id)¶: Get Real-Time Analytics by id :param id: unique id of a big data task :return: endpoint response of Real-Time Analytics for the given id

property items¶: Get all Real-Time Analytics items :return: returns a collection of all configured Real-Time Analytics items

BigDataAnalyticsManager¶

class arcgis.realtime.velocity.BigDataAnalyticsManager(url, gis)¶

Used to manage Big Data Analytics

get(id)¶

Get Big Data Analytics by id

param id: unique id of a big data task

Returns: endpoint response of Big Data Analytics for the given id

property items¶: Get all Big Data Analytics items :return: returns a collection of all configured Big Data Analytics items

Feed¶

class arcgis.realtime.velocity.Feed(gis, util, item=None)¶

Feed class implements Task and provides public facing methods to access Feeds API endpoints

delete()¶: Deletes an existing feed instance :return: A boolean containing True (for success) or

False (for failure) a dictionary with details is returned.

property metrics¶: Get the metrics of the running Feed for the given id :return: response of Feed metrics

start()¶: Start the Feed for the given id :return: response of feed start

property status¶: Get the status of the running Feed for the given id :return: response of Feed status

stop()¶: Stop the Feed for the given id Return True if the Feed was successfully stopped. :return: boolean

RealTimeAnalytics¶

class arcgis.realtime.velocity.RealTimeAnalytics(gis, util, item=None)¶

RealTimeAnalytics class implements Task and provides public facing methods to access RealTimeAnalytics API endpoints

delete()¶: Deletes an existing Real-Time Analytics task instance :return: A boolean containing True (for success) or

False (for failure) a dictionary with details is returned.

property metrics¶: Get the metrics of the running Real-Time Analytics for the given id :return: response of Real-Time Analytics metrics

start()¶: Start the Real-Time Analytics for the given id :return: response of realtime_analytics start

property status¶: Get the status of the running Real-Time Analytics for the given id :return: response of Real-Time Analytics status

stop()¶: Stop the Real-Time Analytics for the given id Return True if the the Real-Time Analytics was successfully stopped. :return: boolean

BigDataAnalytics¶

class arcgis.realtime.velocity.BigDataAnalytics(gis, util, item=None)¶

BigDataAnalytics class implements Task and provides public facing methods to access BigDataAnalytics API endpoints

delete()¶: Deletes an existing Big Data Analytics instance :return: A boolean containing True (for success) or

False (for failure) a dictionary with details is returned.

property metrics¶: Get the metrics of the running Big Data Analytics for the given id :return: response of Big Data Analytics metrics

start()¶: Start the Big Data Analytics for the given id :return: response of bigdata_analytics start

property status¶: Get the status of the running Big Data Analytics for the given id :return: response of Big Data Analytics status

stop()¶: Stop the Big Data Analytics for the given id Return True if the Big Data Analytics was successfully stopped. :return: boolean