metrics_query_event_data

Retrieve real-time aggregated metric data from an event

Functions

async pydelfini.delfini_core.api.metrics.metrics_query_event_data.asyncio(event_name, *, client, dimension=Unset, period, agg_func, partition_by=Unset, num_partitions=Unset, start=Unset, end=Unset)

Retrieve real-time aggregated metric data from an event

Parameters:

• event_name (str)

• dimension (Union[Unset, str])

• period (MetricsQueryEventDataPeriod)

• agg_func (MetricAggFunc)

• partition_by (Union[Unset, str])

• num_partitions (Union[Unset, int])

• start (Union[Unset, datetime.datetime])

• end (Union[Unset, datetime.datetime])

• client (AuthenticatedClient)

Raises:

• errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Union[MetricData]

Return type:

MetricData

async pydelfini.delfini_core.api.metrics.metrics_query_event_data.asyncio_detailed(event_name, *, client, dimension=Unset, period, agg_func, partition_by=Unset, num_partitions=Unset, start=Unset, end=Unset)

Retrieve real-time aggregated metric data from an event

Parameters:

• event_name (str)

• dimension (Union[Unset, str])

• period (MetricsQueryEventDataPeriod)

• agg_func (MetricAggFunc)

• partition_by (Union[Unset, str])

• num_partitions (Union[Unset, int])

• start (Union[Unset, datetime.datetime])

• end (Union[Unset, datetime.datetime])

• client (AuthenticatedClient)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[Union[MetricData, ServerError]]

Return type:

Response[MetricData | ServerError]

pydelfini.delfini_core.api.metrics.metrics_query_event_data.sync(event_name, *, client, dimension=Unset, period, agg_func, partition_by=Unset, num_partitions=Unset, start=Unset, end=Unset)

Retrieve real-time aggregated metric data from an event

Parameters:

• event_name (str)

• dimension (Union[Unset, str])

• period (MetricsQueryEventDataPeriod)

• agg_func (MetricAggFunc)

• partition_by (Union[Unset, str])

• num_partitions (Union[Unset, int])

• start (Union[Unset, datetime.datetime])

• end (Union[Unset, datetime.datetime])

• client (AuthenticatedClient)

Raises:

• errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Union[MetricData]

Return type:

MetricData

pydelfini.delfini_core.api.metrics.metrics_query_event_data.sync_detailed(event_name, *, client, dimension=Unset, period, agg_func, partition_by=Unset, num_partitions=Unset, start=Unset, end=Unset)

Retrieve real-time aggregated metric data from an event

Parameters:

• event_name (str)

• dimension (Union[Unset, str])

• period (MetricsQueryEventDataPeriod)

• agg_func (MetricAggFunc)

• partition_by (Union[Unset, str])

• num_partitions (Union[Unset, int])

• start (Union[Unset, datetime.datetime])

• end (Union[Unset, datetime.datetime])

• client (AuthenticatedClient)

Raises:

• errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

• httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[Union[MetricData, ServerError]]

Return type:

Response[MetricData | ServerError]