Class StatisticSummary

    • Method Detail

      • statisticId

        public final String statisticId()

        The Statistic ID.

        Returns:
        The Statistic ID.
      • profileId

        public final String profileId()

        The Profile ID.

        Returns:
        The Profile ID.
      • runIdentifier

        public final RunIdentifier runIdentifier()

        The Run Identifier

        Returns:
        The Run Identifier
      • statisticName

        public final String statisticName()

        The name of the statistic.

        Returns:
        The name of the statistic.
      • doubleValue

        public final Double doubleValue()

        The value of the statistic.

        Returns:
        The value of the statistic.
      • evaluationLevelAsString

        public final String evaluationLevelAsString()

        The evaluation level of the statistic. Possible values: Dataset, Column, Multicolumn.

        If the service returns an enum value that is not available in the current SDK version, evaluationLevel will return StatisticEvaluationLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from evaluationLevelAsString().

        Returns:
        The evaluation level of the statistic. Possible values: Dataset, Column, Multicolumn.
        See Also:
        StatisticEvaluationLevel
      • hasColumnsReferenced

        public final boolean hasColumnsReferenced()
        For responses, this returns true if the service returned a value for the ColumnsReferenced property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • columnsReferenced

        public final List<String> columnsReferenced()

        The list of columns referenced by the statistic.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasColumnsReferenced() method.

        Returns:
        The list of columns referenced by the statistic.
      • hasReferencedDatasets

        public final boolean hasReferencedDatasets()
        For responses, this returns true if the service returned a value for the ReferencedDatasets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • referencedDatasets

        public final List<String> referencedDatasets()

        The list of datasets referenced by the statistic.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReferencedDatasets() method.

        Returns:
        The list of datasets referenced by the statistic.
      • hasStatisticProperties

        public final boolean hasStatisticProperties()
        For responses, this returns true if the service returned a value for the StatisticProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • statisticProperties

        public final Map<String,​String> statisticProperties()

        A StatisticPropertiesMap, which contains a NameString and DescriptionString

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStatisticProperties() method.

        Returns:
        A StatisticPropertiesMap, which contains a NameString and DescriptionString
      • recordedOn

        public final Instant recordedOn()

        The timestamp when the statistic was recorded.

        Returns:
        The timestamp when the statistic was recorded.
      • inclusionAnnotation

        public final TimestampedInclusionAnnotation inclusionAnnotation()

        The inclusion annotation for the statistic.

        Returns:
        The inclusion annotation for the statistic.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)