Class ExpansionResultAggregation


  • public final class ExpansionResultAggregation
    extends Object
    Information of a specific aggregation in the expansion result.
    • Constructor Detail

      • ExpansionResultAggregation

        public ExpansionResultAggregation()
    • Method Detail

      • aggregationType

        public String aggregationType()
        Get the aggregationType property: The common type of the aggregation. (for e.g. entity field name).
        Returns:
        the aggregationType value.
      • withAggregationType

        public ExpansionResultAggregation withAggregationType​(String aggregationType)
        Set the aggregationType property: The common type of the aggregation. (for e.g. entity field name).
        Parameters:
        aggregationType - the aggregationType value to set.
        Returns:
        the ExpansionResultAggregation object itself.
      • count

        public int count()
        Get the count property: Total number of aggregations of the given kind (and aggregationType if given) in the expansion result.
        Returns:
        the count value.
      • withCount

        public ExpansionResultAggregation withCount​(int count)
        Set the count property: Total number of aggregations of the given kind (and aggregationType if given) in the expansion result.
        Parameters:
        count - the count value to set.
        Returns:
        the ExpansionResultAggregation object itself.
      • displayName

        public String displayName()
        Get the displayName property: The display name of the aggregation by type.
        Returns:
        the displayName value.
      • withDisplayName

        public ExpansionResultAggregation withDisplayName​(String displayName)
        Set the displayName property: The display name of the aggregation by type.
        Parameters:
        displayName - the displayName value to set.
        Returns:
        the ExpansionResultAggregation object itself.
      • entityKind

        public EntityKind entityKind()
        Get the entityKind property: The kind of the aggregated entity.
        Returns:
        the entityKind value.
      • withEntityKind

        public ExpansionResultAggregation withEntityKind​(EntityKind entityKind)
        Set the entityKind property: The kind of the aggregated entity.
        Parameters:
        entityKind - the entityKind value to set.
        Returns:
        the ExpansionResultAggregation object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.