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 Link icon

    • AggregationBucketDetails Link icon

      public AggregationBucketDetails()
  • Method Details Link icon

    • getSourceValue Link icon

      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 Link icon

      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 Link icon

      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 Link icon

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

      public Long getMaxMatchingLength()
      TBC
    • getTo Link icon

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

      public String getToAsString()
      End of a range, as a string.
    • getFrom Link icon

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

      public String getFromAsString()
      Start of a range, as a string.
    • getNestedResults Link icon

      public Map<String,AggregationResult> getNestedResults()
      Nested aggregation results.
    • equals Link icon

      public boolean equals(Object o)
      Overrides:
      equals in class AtlanObject
    • canEqual Link icon

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class AtlanObject
    • hashCode Link icon

      public int hashCode()
      Overrides:
      hashCode in class AtlanObject
    • toString Link icon

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