Skip to content

GetBucketsAggregationRequest

Source code in docs_src/capo_iot/types/get_buckets_aggregation_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
class GetBucketsAggregationRequest(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: "capo_iot.types.aggregation_field.AggregationField"
    """<p>The aggregation field.</p>"""
    query_version: NotRequired["capo_iot.types.query_version.QueryVersion"]
    """<p>The version of the query.</p>"""
    buckets_aggregation_type: (
        "capo_iot.types.buckets_aggregation_type.BucketsAggregationType"
    )
    """<p>The basic control of the response shape and the bucket aggregation type to perform. </p>"""

aggregation_field instance-attribute 

aggregation_field: AggregationField

The aggregation field.

buckets_aggregation_type instance-attribute 

buckets_aggregation_type: BucketsAggregationType

The basic control of the response shape and the bucket aggregation type to perform.

index_name instance-attribute 

index_name: NotRequired[IndexName]

The name of the index to search.

query_string instance-attribute 

query_string: QueryString

The search query string.

query_version instance-attribute 

query_version: NotRequired[QueryVersion]

The version of the query.