Skip to content

DataSegmentSummary

Source code in docs_src/capo_iotsitewise/types/data_segment_summary.py
class DataSegmentSummary(TypedDict, closed=True):
    source_dataset_id: "capo_iotsitewise.types.id.ID"
    """<p>The ID of the source dataset that contains the data segment.</p>"""
    time_series_id: "capo_iotsitewise.types.time_series_id.TimeSeriesId"
    """<p>The ID of the time series.</p>"""
    start_timestamp: "capo_iotsitewise.types.time_in_nanos.TimeInNanos"
    """<p>The nanosecond-precision start time of the data segment.</p>"""
    end_timestamp: "capo_iotsitewise.types.time_in_nanos.TimeInNanos"
    """<p>The nanosecond-precision end time of the data segment.</p>"""
    alias: "capo_iotsitewise.types.property_alias.PropertyAlias"
    """<p>The alias of the time series.</p>"""
    data_type: "capo_iotsitewise.types.property_data_type.PropertyDataType"
    """<p>The data type of the time series.</p>"""
    enrichment: NotRequired[
        "capo_iotsitewise.types.data_segment_enrichment.DataSegmentEnrichment"
    ]
    """<p>The enrichment information for the data segment.</p>"""

alias instance-attribute

The alias of the time series.

data_type instance-attribute

data_type: PropertyDataType

The data type of the time series.

end_timestamp instance-attribute

end_timestamp: TimeInNanos

The nanosecond-precision end time of the data segment.

enrichment instance-attribute

enrichment: NotRequired[DataSegmentEnrichment]

The enrichment information for the data segment.

source_dataset_id instance-attribute

source_dataset_id: ID

The ID of the source dataset that contains the data segment.

start_timestamp instance-attribute

start_timestamp: TimeInNanos

The nanosecond-precision start time of the data segment.

time_series_id instance-attribute

time_series_id: TimeSeriesId

The ID of the time series.