starting point for adding python sdk docs

This commit is contained in:
darrell-thobe-sp
2025-02-20 12:59:19 -05:00
parent 3b9e39ca19
commit c18583ede4
2726 changed files with 370294 additions and 5 deletions

View File

@@ -0,0 +1,55 @@
---
id: search-aggregation-specification
title: SearchAggregationSpecification
pagination_label: SearchAggregationSpecification
sidebar_label: SearchAggregationSpecification
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'SearchAggregationSpecification', 'SearchAggregationSpecification']
slug: /tools/sdk/python/v3/models/search-aggregation-specification
tags: ['SDK', 'Software Development Kit', 'SearchAggregationSpecification', 'SearchAggregationSpecification']
---
# SearchAggregationSpecification
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**nested** | [**NestedAggregation**](nested-aggregation) | | [optional]
**metric** | [**MetricAggregation**](metric-aggregation) | | [optional]
**filter** | [**FilterAggregation**](filter-aggregation) | | [optional]
**bucket** | [**BucketAggregation**](bucket-aggregation) | | [optional]
**sub_aggregation** | [**SubSearchAggregationSpecification**](sub-search-aggregation-specification) | | [optional]
}
## Example
```python
from sailpoint.v3.models.search_aggregation_specification import SearchAggregationSpecification
search_aggregation_specification = SearchAggregationSpecification(
nested=sailpoint.v3.models.nested_aggregation.NestedAggregation(
name = 'id',
type = 'access', ),
metric=sailpoint.v3.models.metric_aggregation.MetricAggregation(
name = 'Access Name Count',
type = 'UNIQUE_COUNT',
field = '@access.name', ),
filter=sailpoint.v3.models.filter_aggregation.FilterAggregation(
name = 'Entitlements',
type = 'TERM',
field = 'access.type',
value = 'ENTITLEMENT', ),
bucket=sailpoint.v3.models.bucket_aggregation.BucketAggregation(
name = 'Identity Locations',
type = 'TERMS',
field = 'attributes.city',
size = 100,
min_doc_count = 2, ),
sub_aggregation=
)
```
[[Back to top]](#)