Skip to content

GetPercentilesRequest

Source code in docs_src/capo_iot/types/get_percentiles_request.py
class GetPercentilesRequest(TypedDict, closed=True):
    index_name: NotRequired["capo_iot.types.index_name.IndexName"]
    """<p>The name of the index to search.</p>"""
    query_string: "capo_iot.types.query_string.QueryString"
    """<p>The search query string.</p>"""
    aggregation_field: NotRequired["capo_iot.types.aggregation_field.AggregationField"]
    """<p>The field to aggregate.</p>"""
    query_version: NotRequired["capo_iot.types.query_version.QueryVersion"]
    """<p>The query version.</p>"""
    percents: NotRequired["capo_iot.types.percent_list.PercentList"]
    """<p>The percentile groups returned.</p>"""

aggregation_field instance-attribute

aggregation_field: NotRequired[AggregationField]

The field to aggregate.

index_name instance-attribute

index_name: NotRequired[IndexName]

The name of the index to search.

percents instance-attribute

percents: NotRequired[PercentList]

The percentile groups returned.

query_string instance-attribute

query_string: QueryString

The search query string.

query_version instance-attribute

query_version: NotRequired[QueryVersion]

The query version.