Skip to content

TimeseriesItem

Source code in docs_src/capo_iotsitewise/types/timeseries_item.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
class TimeseriesItem(TypedDict, closed=True):
    time_series_id: NotRequired["capo_iotsitewise.types.time_series_id.TimeSeriesId"]
    """<p>The unique identifier for the timeseries. Mutually exclusive with propertyAlias.</p>"""
    property_alias: NotRequired[
        "capo_iotsitewise.types.asset_property_alias.AssetPropertyAlias"
    ]
    """<p>The customer-friendly alias for the timeseries. Mutually exclusive with timeSeriesId.</p>"""
    trim_settings: NotRequired["capo_iotsitewise.types.trim_settings.TrimSettings"]
    """<p>The trim settings for the time range to export. Required for VIDEO and TELEMETRY data types; optional for ANNOTATION data types.</p>"""
    format_settings: NotRequired[
        "capo_iotsitewise.types.format_settings.FormatSettings"
    ]
    """<p>The optional format settings for the output.</p>"""

format_settings instance-attribute 

format_settings: NotRequired[FormatSettings]

The optional format settings for the output.

property_alias instance-attribute 

property_alias: NotRequired[AssetPropertyAlias]

The customer-friendly alias for the timeseries. Mutually exclusive with timeSeriesId.

time_series_id instance-attribute 

time_series_id: NotRequired[TimeSeriesId]

The unique identifier for the timeseries. Mutually exclusive with propertyAlias.

trim_settings instance-attribute 

trim_settings: NotRequired[TrimSettings]

The trim settings for the time range to export. Required for VIDEO and TELEMETRY data types; optional for ANNOTATION data types.