Event Streams

Using the Event Streams service collection

Table of Contents

Operation ID	Description
refreshActiveStreamSession PEP 8 refresh_active_stream	Refresh an active event stream. Use the URL shown in a GET /sensors/entities/datafeed/v2 response.
listAvailableStreamsOAuth2 PEP 8 list_available_streams	Discover all event streams in your environment

refreshActiveStreamSession

Refresh an active event stream. Use the URL shown in a listAvailableStreamsOAuth2 response.

PEP8 method name

refresh_active_stream

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
action_name			query	string	The name of the action to perform. The only allowed value is refresh_active_stream_session. Defaults to this value if not present when using the Service Class.
app_id			query	string	Label that identifies your connection. Max: 32 alphanumeric characters (a-z, A-Z, 0-9). Will also accept the keyword appId to specify this value.
partition			path	integer	Partition to request data for. If you are using the Service Class, this will default to 0 when not specified.
parameters			query	string	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import EventStreams

falcon = EventStreams(client_id="API_CLIENT_ID_HERE",
                      client_secret="API_CLIENT_SECRET_HERE"
                      )

PARTITION = 0   #Refresh the partition we are working with

response = falcon.refresh_active_stream(action_name="string",
                                        app_id="string",
                                        partition=PARTITION
                                        )
print(response)

Service class example (Operation ID syntax)

from falconpy import EventStreams

falcon = EventStreams(client_id="API_CLIENT_ID_HERE",
                      client_secret="API_CLIENT_SECRET_HERE"
                      )

PARTITION = 0   #Refresh the partition we are working with

response = falcon.refreshActiveStreamSession(action_name="string",
                                             app_id="string",
                                             partition=PARTITION
                                             )
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

PARTITION = 0   #Refresh the partition we are working with

response = falcon.command("refreshActiveStreamSession",
                          app_id="string",
                          partition=PARTITION,
                          action_name="string"
                          )
print(response)

listAvailableStreamsOAuth2

Discover all event streams in your environment

PEP8 method name

list_available_streams

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
app_id			query	string	Label that identifies your connection. Max: 32 alphanumeric characters (a-z, A-Z, 0-9). Will also accept the keyword appId to specify this value.
format			query	string	Format for streaming events. Valid values: json, flatjson
parameters			query	string	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import EventStreams

falcon = EventStreams(client_id="API_CLIENT_ID_HERE",
                      client_secret="API_CLIENT_SECRET_HERE"
                      )

response = falcon.list_available_streams(app_id="string", format="string")
print(response)

Service class example (Operation ID syntax)

from falconpy import EventStreams

falcon = EventStreams(client_id="API_CLIENT_ID_HERE",
                      client_secret="API_CLIENT_SECRET_HERE"
                      )

response = falcon.listAvailableStreamsOAuth2(app_id="string", format="string")
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.command("listAvailableStreamsOAuth2", app_id="string", format="string")
print(response)