Class Statistics

java.lang.Object
software.amazon.awssdk.services.neptunedata.model.Statistics
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Statistics.Builder,Statistics>
@Generated("software.amazon.awssdk:codegen") public final class Statistics extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Statistics.Builder,Statistics>

Contains statistics information. The DFE engine uses information about the data in your Neptune graph to make effective trade-offs when planning query execution. This information takes the form of statistics that include so-called characteristic sets and predicate statistics that can guide query planning. See Managing statistics for the Neptune DFE to use.

See Also:

  • Method Details

    • autoCompute

      public final Boolean autoCompute()

      Indicates whether or not automatic statistics generation is enabled.

      Returns:
      Indicates whether or not automatic statistics generation is enabled.

    • active

      public final Boolean active()

      Indicates whether or not DFE statistics generation is enabled at all.

      Returns:
      Indicates whether or not DFE statistics generation is enabled at all.

    • statisticsId

      public final String statisticsId()

      Reports the ID of the current statistics generation run. A value of -1 indicates that no statistics have been generated.

      Returns:
      Reports the ID of the current statistics generation run. A value of -1 indicates that no statistics have been generated.

    • date

      public final Instant date()

      The UTC time at which DFE statistics have most recently been generated.

      Returns:
      The UTC time at which DFE statistics have most recently been generated.

    • note

      public final String note()

      A note about problems in the case where statistics are invalid.

      Returns:
      A note about problems in the case where statistics are invalid.

    • signatureInfo

      public final StatisticsSummary signatureInfo()

      A StatisticsSummary structure that contains:

      • signatureCount - The total number of signatures across all characteristic sets.

      • instanceCount - The total number of characteristic-set instances.

      • predicateCount - The total number of unique predicates.

      Returns:
      A StatisticsSummary structure that contains:

      • signatureCount - The total number of signatures across all characteristic sets.

      • instanceCount - The total number of characteristic-set instances.

      • predicateCount - The total number of unique predicates.

    • toBuilder

      public Statistics.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Statistics.Builder,Statistics>
      Returns:
      a builder for type T

    • builder

      public static Statistics.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Statistics.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.