Package com.atlan.model.search

Class AggregationBucketDetails

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.search.AggregationBucketDetails
All Implemented Interfaces:
Serializable
public class AggregationBucketDetails extends AtlanObject
Captures the results of a single bucket within an aggregation.
See Also:

  • Constructor Details

    • AggregationBucketDetails

      public AggregationBucketDetails()

  • Method Details

    • getSourceValue

      public Object getSourceValue(AtlanField field)
      Return the source value of the specified field for this bucket.
      Parameters:
      field - field in Atlan for which to retrieve the value
      Returns:
      the value of the field in Atlan that is represented within this bucket, if any

    • getKeyAsString

      public String getKeyAsString()
      Key of the field representing this bucket of aggregate results, as a string. For example, when the key is a date (numeric) this will be something like "2015-01-01".

    • getKey

      public Object getKey()
      Key of the field representing this bucket of aggregate results. This could be a string, a number (in the case of dates), or an array (in the case of multi-term aggregations).

    • getDocCount

      public Long getDocCount()
      Number of results that fit within this bucket of the aggregation.

    • getMaxMatchingLength

      public Long getMaxMatchingLength()
      TBC

    • getTo

      public Object getTo()
      End of a range (date, geo, IP, etc), as a number or string.

    • getToAsString

      public String getToAsString()
      End of a range, as a string.

    • getFrom

      public Object getFrom()
      Start of a range (date, geo, IP, etc), as a number or string.

    • getFromAsString

      public String getFromAsString()
      Start of a range, as a string.

    • getNestedResults

      public Map<String,AggregationResult> getNestedResults()
      Nested aggregation results.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class AtlanObject

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class AtlanObject

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class AtlanObject

    • toString

      public String toString()
      Description copied from class: AtlanObject
      Overrides:
      toString in class AtlanObject