Skip to main content

Bucketaggregation

The bucket to group the results of the aggregation query by.

Properties

NameTypeDescriptionNotes
namestrThe name of the bucket aggregate to be included in the result.[required]
typeBuckettype[optional] [default to Buckettype.TERMS]
var_fieldstrThe field to bucket on. Prefix the field name with '@' to reference a nested object.[required]
sizeintMaximum number of buckets to include.[optional]
min_doc_countintMinimum number of documents a bucket should have.[optional]
}

Example

from sailpoint.search.models.bucketaggregation import Bucketaggregation

bucketaggregation = Bucketaggregation(
name='Identity Locations',
type='TERMS',
var_field='attributes.city',
size=100,
min_doc_count=2
)

[Back to top]