arcgis.realtime.velocity.feeds module

# Usage Example

from arcgis.realtime.velocity.feeds import RSS
from arcgis.realtime.velocity.http_authentication_type import (
    NoAuth,
    BasicAuth,
    CertificateAuth,
)

from arcgis.realtime.velocity.input.format import GeoRssFormat
from arcgis.realtime.velocity.feeds.geometry import XYZGeometry, SingleFieldGeometry
from arcgis.realtime.velocity.feeds.time import TimeInterval, TimeInstant
from arcgis.realtime.velocity.feeds.run_interval import RunInterval

name = "rss feed name"
description = "rss feed description"
url = "rss feed url"
http_auth = NoAuth()
# http_auth = BasicAuth(username="username", password="password")
# http_auth = CertificateAuth(pfx_file_http_location="https://link", password="password")

http_headers = {
    "Content-Type": "application/json"
}

# all properties can also be defined in the constructor as follows

# Set data format
data_format = GeoRssFormat()

# Set geometry field
geometry = XYZGeometry(
    x_field="category_longitude",
    y_field="category_latitude",
    wkid=4326,
    z_field="category_altitude",
    z_unit="Meters"
)

# Set time field
time = TimeInterval(
    interval_start_field="start_field",
    interval_end_field="end_field"
)

# Set recurrence
run_interval = RunInterval(
    cron_expression="0 * * ? * * *",
    timezone="America/Los_Angeles"
)

# Configure the RSS Feed
rss = RSS(
    label="feed_name",
    description="feed_description",
    rss_url=url,
    http_auth_type=http_auth,
    http_headers=http_headers,
    track_id_field="track_id",
    data_format=data_format,
    geometry=geometry,
    time=time,
    run_interval=run_interval
)

# use velocity object to get the FeedsManager instance
feeds = velocity.feeds

# use the FeedsManager object to create a feed from this feed configuration
RSS_feed = feeds.create(rss)
RSS_feed.start()
feeds.items

# Usage Example

from arcgis.realtime.velocity.feeds import HttpPoller
from arcgis.realtime.velocity.http_authentication_type import (
    NoAuth,
    BasicAuth,
    CertificateAuth,
)
arcgis.realtime.velocity.input.format import DelimitedFormat
from arcgis.realtime.velocity.feeds.geometry import XYZGeometry, SingleFieldGeometry
from arcgis.realtime.velocity.feeds.time import TimeInterval, TimeInstant
from arcgis.realtime.velocity.feeds.run_interval import RunInterval

name = "http_poller_feed_name"
description = "http_poller_description_feed"
url = "http_poller_url"
http_auth = NoAuth()
# http_auth = BasicAuth(username="username", password="password")
# http_auth = CertificateAuth(pfx_file_http_location="http_auth_link", password="password")

http_headers = {"Content-Type": "application/json"}
url_params = {"f": "json"}

http_poller = HttpPoller(
    label=name,
    description=description,
    url=url,
    http_method="GET",
    http_auth_type=http_auth,
    url_params=url_params,
    http_headers=http_headers,
    enable_long_polling=False,
    data_format=None
)

# Set track id field
http_poller.set_track_id("track_id")

# Set time field
time = TimeInstant(time_field="time_field")
http_poller.set_time_config(time=time)

# Set geometry field
geometry = XYZGeometry(
    x_field="x",
    y_field="y",
    wkid=4326
)
http_poller.set_geometry_config(geometry=geometry)

# Set recurrence
http_poller.run_interval = RunInterval(
    cron_expression="0 * * ? * * *", timezone="America/Los_Angeles"
)

# use velocity object to get the FeedsManager instance
feeds = velocity.feeds

# use the FeedsManager object to create a feed from this feed configuration
http_poller_feed = feeds.create(http_poller)
http_poller_feed.start()
feeds.items

# Usage Example

from arcgis.realtime.velocity.feeds import HttpReceiver
from arcgis.realtime.velocity.http_authentication_type import (
    NoAuth,
    BasicAuth,
    CertificateAuth,
)

sample_message="name,age

dan,23"

http_receiver = HttpReceiver(
    label="feed_name",
    description="feed_description",
    authentication_type="none",
    sample_message=sample_message,
    data_format=None
)

# use velocity object to get the FeedsManager instance
feeds = velocity.feeds

# use the FeedsManager object to create a feed from this feed configuration
http_receiver_feed = feeds.create(http_receiver)
http_receiver_feed.start()
feeds.items

# Usage Example

from arcgis.realtime.velocity.feeds import HttpSimulator
from arcgis.realtime.velocity.input.format import DelimitedFormat
from arcgis.realtime.velocity.feeds.geometry import XYZGeometry, SingleFieldGeometry
from arcgis.realtime.velocity.feeds.time import TimeInterval, TimeInstant

http_simulator = HttpSimulator(
    label="feed_name",
    description="feed_description",
    url="http_simulator_url",
    data_format=None
)

# use velocity object to get the FeedsManager instance
feeds = velocity.feeds

# use the FeedsManager object to create a feed from this feed configuration
http_simulator_feed = feeds.create(http_simulator)
http_simulator_feed.start()
feeds.items

# Usage Example

from arcgis.realtime.velocity.feeds import AWSIoT
from arcgis.realtime.velocity.feeds.geometry import XYZGeometry, SingleFieldGeometry
from arcgis.realtime.velocity.feeds.time import TimeInterval, TimeInstant

aws_config = AWSIoT(
    label="feed_name",
    description="feed_description",
    endpoint="aws_iot feed endpoint",
    topic="aws_iot_topic",
    qos_level=0,
    access_key_id="aws_iot_access_key_id",
    secret_access_key="aws_iot_secret_access_key",
    data_format=None
)

# use velocity object to get the FeedsManager instance
feeds = velocity.feeds

# use the FeedsManager object to create a feed from this feed configuration
aws_feed = feeds.create(aws_config)
aws_feed.start()
feeds.items

# Usage Example

from arcgis.realtime.velocity.feeds import AzureEventHub
from arcgis.realtime.velocity.feeds.geometry import XYZGeometry, SingleFieldGeometry
from arcgis.realtime.velocity.feeds.time import TimeInterval, TimeInstant

azure_event_hub_config = AzureEventHub(
    label="feed_name",
    description="feed_description",
    shared_access_key_name="azure_event_hub_shared_key_name",
    shared_access_key="azure_event_hub_shared_key",
    event_hub_endpoint="azure_event_hub_endpoint",
    event_hub_entity_path="azure_event_hub_entity_path",
    consumer_group="azure_consumer_group",
    data_format=None
)

# use velocity object to get the FeedsManager instance
feeds = velocity.feeds

# use the FeedsManager object to create a feed from this feed configuration
azure_event_hub_feed = feeds.create(azure_event_hub_config)
azure_event_hub_feed.start()
feeds.items

# Usage Example

from arcgis.realtime.velocity.feeds import AzureServiceBus
from arcgis.realtime.velocity.feeds.geometry import XYZGeometry, SingleFieldGeometry
from arcgis.realtime.velocity.feeds.time import TimeInterval, TimeInstant

azure_service_bus_config = AzureServiceBus(
    label="feed_name",
    description="feed_description",
    topic_name="azure_service_bus_topic_name",
    subscription_name="azure_service_bus_subscription_name",
    shared_access_key_name="azure_service_bus_shared_access_key_name",
    shared_access_key="azure_service_bus_shared_access_key",
    endpoint="azure_service_bus_endpoint",
    data_format=None
)

# use velocity object to get the FeedsManager instance
feeds = velocity.feeds

# use the FeedsManager object to create a feed from this feed configuration
azure_service_bus_feed = feeds.create(azure_service_bus_config)
azure_service_bus_feed.start()
feeds.items

# Usage Example

from arcgis.realtime.velocity.feeds import CiscoEdgeIntelligence
from arcgis.realtime.velocity.feeds.geometry import XYZGeometry, SingleFieldGeometry
from arcgis.realtime.velocity.feeds.time import TimeInterval, TimeInstant

cisco_edge_config = CiscoEdgeIntelligence(
    label="feed_name",
    description="feed_description",
    host="cisco_host",
    port="cisco_port",
    topic="cisco_topic",
    qos_level=0,
    username="cisco_username",
    password="cisco_password",
    client_id="cisco_client_id",
    data_format=None
)

# use velocity object to get the FeedsManager instance
feeds = velocity.feeds

# use the FeedsManager object to create a feed from this feed configuration
cisco_edge_feed = feeds.create(cisco_edge_config)
cisco_edge_feed.start()
feeds.items

# Usage Example

from arcgis.realtime.velocity.feeds import FeatureLayer
from arcgis.realtime.velocity.http_authentication_type import (
    NoAuth,
    BasicAuth,
    CertificateAuth,
)

from arcgis.realtime.velocity.input.format import DelimitedFormat
from arcgis.realtime.velocity.feeds.geometry import XYZGeometry, SingleFieldGeometry
from arcgis.realtime.velocity.feeds.time import TimeInterval, TimeInstant
from arcgis.realtime.velocity.feeds.run_interval import RunInterval

extent = {
    "spatialReference": {
        "latestWkid": 3857,
        "wkid": 102100
    },
    "xmin": "xmin",
    "ymin": "ymin",
    "xmax": "xmax",
    "ymax": "ymax"
}

# Feature Layer Properties

feature_layer_config = FeatureLayer(
    label="feed_name",
    description="feed_description",
    query="1=1",
    fields="*",
    outSR=4326,
    url="feed_sample_server_link",
    extent=extent,
    time_stamp_field="date_field"
)

feature_layer_config

# Set recurrence
feature_layer_config.run_interval = RunInterval(
    cron_expression="0 * * ? * * *", timezone="America/Los_Angeles"
)

# use velocity object to get the FeedsManager instance
feeds = velocity.feeds

# use the FeedsManager object to create a feed from this feed configuration
feature_layer_feed = feeds.create(feature_layer_config)
feature_layer_feed.start()
feeds.items

# Usage Example

from arcgis.realtime.velocity.feeds import StreamLayer
from arcgis.realtime.velocity.feeds.time import TimeInterval, TimeInstant

extent = {
    "spatialReference": {
        "latestWkid": 3857,
        "wkid": 102100
    },
    "xmin": "xmin",
    "ymin": "ymin",
    "xmax": "xmax",
    "ymax": "ymax"
}

stream_layer_config = StreamLayer(
    label="feed_name",
    description="feed_description",
    portal_item_id="portal_id",
    query="1=1",
    fields="*",
    outSR=4326,
    extent=extent
)

# use velocity object to get the FeedsManager instance
feeds = velocity.feeds

# use the FeedsManager object to create a feed from this feed configuration
stream_layer_feed = feeds.create(stream_layer_config)
stream_layer_feed.start()
feeds.items

# Usage Example

from arcgis.realtime.velocity.feeds import Geotab
from arcgis.realtime.velocity.feeds.geometry import XYZGeometry, SingleFieldGeometry
from arcgis.realtime.velocity.feeds.time import TimeInterval, TimeInstant

geotab = Geotab(
    label="feed_name",
    description="feed_description",
    url="Geotab_url",
    database="Geotab_database",
    username="Geotab_user_name",
    password="Geotab_password",
    data_format=None
)

# use velocity object to get the FeedsManager instance
feeds = velocity.feeds

# use the FeedsManager object to create a feed from this feed configuration
geotab_feed = feeds.create(geotab)
geotab_feed.start()
feeds.items

# Usage Example

from arcgis.realtime.velocity.feeds import Kafka
from arcgis.realtime.velocity.feeds.kafka_authentication_type import NoAuth, SASLPlain
from arcgis.realtime.velocity.feeds.geometry import XYZGeometry, SingleFieldGeometry
from arcgis.realtime.velocity.feeds.time import TimeInterval, TimeInstant

kafka_config = Kafka(
    label="feed_name",
    description="feed_description",
    brokers="kafka.a4iot.com:9092",
    topics="topicName",
    authentication=NoAuth(),
    data_format=None
)

# use velocity object to get the FeedsManager instance
feeds = velocity.feeds

# use the FeedsManager object to create a feed from this feed configuration
kafka_feed = feeds.create(kafka_config)
kafka_feed.start()
feeds.items

# Usage Example

from arcgis.realtime.velocity.feeds import MQTT
from arcgis.realtime.velocity.feeds.geometry import XYZGeometry, SingleFieldGeometry
from arcgis.realtime.velocity.feeds.time import TimeInterval, TimeInstant

mqtt_config = MQTT(
    label="feed_name",
    description="feed_description",
    host="Mqtt host",
    port=8883,
    topic="Mqtt topic",
    qos_level=0,
    username="Mqtt_username",
    password="Mqtt_password",
    client_id="Mqtt_client_id",
    data_format=None
)

# use velocity object to get the FeedsManager instance
feeds = velocity.feeds

# use the FeedsManager object to create a feed from this feed configuration
mqtt_feed = feeds.create(mqtt_config)
mqtt_feed.start()
feeds.items

# Usage Example

from arcgis.realtime.velocity.feeds import RabbitMQ
from arcgis.realtime.velocity.feeds.geometry import XYZGeometry, SingleFieldGeometry
from arcgis.realtime.velocity.feeds.time import TimeInterval, TimeInstant

rabbitmq_config = RabbitMQ(
    label="feed_name",
    description="feed_description",
    host="RabbitMQ host",
    username="RabbitMQ_username",
    password="RabbitMQ password",
    prefetch_count=0,
    queue_name="RabbitMQ_queue_name",
    data_format=None
)

# use velocity object to get the FeedsManager instance
feeds = velocity.feeds

# use the FeedsManager object to create a feed from this feed configuration
rabbitmq_feed = feeds.create(rabbitmq_config)
rabbitmq_feed.start()
feeds.items

# Usage Example

from arcgis.realtime.velocity.feeds import VerizonConnectReveal
from arcgis.realtime.velocity.input.format import DelimitedFormat
from arcgis.realtime.velocity.feeds.geometry import XYZGeometry, SingleFieldGeometry
from arcgis.realtime.velocity.feeds.time import TimeInterval, TimeInstant

verizon_connect_reveal = VerizonConnectReveal(
    label="feed_name",
    description="feed_description",
    username = "username",
    password = "password",
    data_format=None
)

# user can't change the schema

verizon_connect_reveal.set_track_id("SequenceId")

# create verizon connect reveal feed

# use velocity object to get the FeedsManager instance
feeds = velocity.feeds

# use the FeedsManager object to create a feed from this feed configuration
verizon_connect_reveal_feed = feeds.create(verizon_connect_reveal)
verizon_connect_reveal_feed.start()
feeds.items

# Usage Example

from arcgis.realtime.velocity.feeds import WebSocket
from arcgis.realtime.velocity.input.format import DelimitedFormat
from arcgis.realtime.velocity.feeds.geometry import XYZGeometry, SingleFieldGeometry
from arcgis.realtime.velocity.feeds.time import TimeInterval, TimeInstant

web_socket = WebSocket(
    label="feed_name",
    description="feed_description",
    url = "http://feed_url.com"
)

# create web socket feed

# use velocity object to get the FeedsManager instance
feeds = velocity.feeds

# use the FeedsManager object to create a feed from this feed configuration
web_socket_feed = feeds.create(web_socket)
web_socket_feed.start()
feeds.items

# Usage Example

geometry = XYZGeometry(
    x_field = "x",
    y_field = "y",
    wkid = 4326
)

# Usage Example

geometry = SingleFieldFeometry(
    geometry_field="geometry_field"
    geometry_type="esriGeometryPoint",
    geometry_format="esrijson",
    wkid=4326
)

# Usage Example

time = TimeInstant(time_field="time_field")

# Usage Example

time = TimeInterval(
    interval_start_field="start_field",
    interval_end_field="end_field"
)

# Usage Example

feed.run_interval = RunInterval(
    cron_expression="0 * * ? * * *", timezone="America/Los_Angeles",
)

# Seconds value must be between 10 and 59
# Minutes value must be between 1 and 59
# Hours value must be between 1 and 23