Skip to main content

BucketAggregation

Properties

NameTypeDescriptionNotes
NameStringThe name of the bucket aggregate to be included in the result.[required]
TypeBucketType[optional]
FieldStringThe field to bucket on. Prefix the field name with '@' to reference a nested object.[required]
SizeInt32Maximum number of buckets to include.[optional]
MinDocCountInt32Minimum number of documents a bucket should have.[optional]

Examples

  • Prepare the resource
$BucketAggregation = Initialize-PSSailpoint.V3BucketAggregation  -Name Identity Locations `
-Type null `
-Field attributes.city `
-Size 100 `
-MinDocCount 2
  • Convert the resource to JSON
$BucketAggregation | ConvertTo-JSON

[Back to top]