Captures - Access object to captures¶
Provides access API to the capture resources.
Request Methods¶
Warning
Be sure to create the access object using captures on client.
client = intdash.Client(...)
client.captures.get(uuid='bd670121-e420-49d5-b3eb-e6b5c103e454')
- class Captures(...)[source]¶
Access object to the capture resources.
- create(name, start, duration=None, shared=True, description='')[source]¶
Create a capture on the server.
- Parameters
name (str) – Capture name
start (pandas.Timestamp) – Start time
description (str) – Description
shared (bool) – Shared flag
duration (pandas.Timedelta) – Duration
- Returns
Created capture object
- Return type
- delete(uuid)[source]¶
Delete the capture from the server.
- Parameters
uuid (str) – UUID of the capture to be deleted
- get(uuid)[source]¶
Retrieves a capture.
- Parameters
uuid (str) – UUID of the capture to retrieve
- Returns
Capture object
- Return type
- list(start, end, name=None, sort='name', order='asc', limit=100, page=1, iterator=False)[source]¶
Retrieve a list of captures.
- Parameters
start (pandas.Timestamp) – Start point of retrieval range
end (pandas.Timestamp) – End point of retrieval range
name (str) – Query for capture name
sort (str) – Field name used for sorting
order (str) – Sort order (
asc
ordesc
)limit (int) – Maximum number of items retrieved
page (int) – Page number
iterator (bool) – If True, generate an iterator
- Returns
List of capture objects
- Return type
list[Capture]
Note
list[Capture]
contain the captures you have created, and all captures created by device-type edges. It doesn’t include Captures created by user-type edges.
- update(uuid, name=None, start=None, duration=None, shared=None, description=None)[source]¶
Update the capture.
- Parameters
uuid (str) – UUID of the measurement to be updated
name (str) – Capture name
start (pandas.Timestamp) – Start time
duration (pandas.Timedelta) – Duration
shared (bool) – Shared flag
description (str) – Description
Response¶
- class Capture(...)[source]¶
An object that represents a capture resource.
- uuid¶
UUID
- Type
str
- name¶
Capture name
- Type
str
- description¶
Description
- Type
str
- start¶
Start time
- Type
pandas.Timestamp
- duration¶
Duration
- Type
pandas.Timedelta
- edge_uuid¶
UUID of the edge associated with the capture
- Type
str
Shared flag
- Type
bool
- created_at¶
Created time
- Type
pandas.Timestamp
- updated_at¶
Updated time
- Type
pandas.Timestamp