Skip to content

StartSessionsStatisticsAggregationRequest

Source code in docs_src/capo_deadline/types/start_sessions_statistics_aggregation_request.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class StartSessionsStatisticsAggregationRequest(TypedDict, closed=True):
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The identifier of the farm that contains queues or fleets to return statistics for.</p>"""
    resource_ids: (
        "capo_deadline.types.sessions_statistics_resources.SessionsStatisticsResources"
    )
    """<p>A list of fleet IDs or queue IDs to gather statistics for.</p>"""
    start_time: "capo_deadline.types.timestamp.Timestamp"
    """<p>The Linux timestamp of the date and time that the statistics start.</p>"""
    end_time: "capo_deadline.types.timestamp.Timestamp"
    """<p>The Linux timestamp of the date and time that the statistics end.</p>"""
    timezone: NotRequired["capo_deadline.types.timezone.Timezone"]
    """<p>The time zone to use for the statistics. Use UTC notation such as "UTC+8."</p>"""
    period: NotRequired["capo_deadline.types.period.Period"]
    """<p>The period to aggregate the statistics.</p>"""
    group_by: "capo_deadline.types.usage_group_by.UsageGroupBy"
    """<p>The field to use to group the statistics.</p>"""
    statistics: "capo_deadline.types.usage_statistics.UsageStatistics"
    """<p>One to four statistics to return.</p>"""

end_time instance-attribute 

end_time: Timestamp

The Linux timestamp of the date and time that the statistics end.

farm_id instance-attribute 

farm_id: FarmId

The identifier of the farm that contains queues or fleets to return statistics for.

group_by instance-attribute 

group_by: UsageGroupBy

The field to use to group the statistics.

period instance-attribute 

period: NotRequired[Period]

The period to aggregate the statistics.

resource_ids instance-attribute 

resource_ids: SessionsStatisticsResources

A list of fleet IDs or queue IDs to gather statistics for.

start_time instance-attribute 

start_time: Timestamp

The Linux timestamp of the date and time that the statistics start.

statistics instance-attribute 

statistics: UsageStatistics

One to four statistics to return.

timezone instance-attribute 

timezone: NotRequired[Timezone]

The time zone to use for the statistics. Use UTC notation such as "UTC+8."