Class FindingStatistics

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

Contains information about finding statistics.

See Also:

  • Method Details

    • hasCountBySeverity

      @Deprecated public final boolean hasCountBySeverity()
      Deprecated.
      This parameter is deprecated. Please set GroupBy to 'SEVERITY' to return GroupedBySeverity instead.
      For responses, this returns true if the service returned a value for the CountBySeverity 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.

    • countBySeverity

      @Deprecated public final Map<String,Integer> countBySeverity()
      Deprecated.
      This parameter is deprecated. Please set GroupBy to 'SEVERITY' to return GroupedBySeverity instead.

      Represents a list of map of severity to count statistics for a set of findings.

      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 hasCountBySeverity() method.

      Returns:
      Represents a list of map of severity to count statistics for a set of findings.

    • hasGroupedByAccount

      public final boolean hasGroupedByAccount()
      For responses, this returns true if the service returned a value for the GroupedByAccount 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.

    • groupedByAccount

      public final List<AccountStatistics> groupedByAccount()

      Represents a list of map of accounts with a findings count associated with each account.

      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 hasGroupedByAccount() method.

      Returns:
      Represents a list of map of accounts with a findings count associated with each account.

    • hasGroupedByDate

      public final boolean hasGroupedByDate()
      For responses, this returns true if the service returned a value for the GroupedByDate 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.

    • groupedByDate

      public final List<DateStatistics> groupedByDate()

      Represents a list of map of dates with a count of total findings generated on each date per severity level.

      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 hasGroupedByDate() method.

      Returns:
      Represents a list of map of dates with a count of total findings generated on each date per severity level.

    • hasGroupedByFindingType

      public final boolean hasGroupedByFindingType()
      For responses, this returns true if the service returned a value for the GroupedByFindingType 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.

    • groupedByFindingType

      public final List<FindingTypeStatistics> groupedByFindingType()

      Represents a list of map of finding types with a count of total findings generated for each type.

      Based on the orderBy parameter, this request returns either the most occurring finding types or the least occurring finding types. If the orderBy parameter is ASC, this will represent the least occurring finding types in your account; otherwise, this will represent the most occurring finding types. The default value of orderBy is DESC.

      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 hasGroupedByFindingType() method.

      Returns:
      Represents a list of map of finding types with a count of total findings generated for each type.

      Based on the orderBy parameter, this request returns either the most occurring finding types or the least occurring finding types. If the orderBy parameter is ASC, this will represent the least occurring finding types in your account; otherwise, this will represent the most occurring finding types. The default value of orderBy is DESC.

    • hasGroupedByResource

      public final boolean hasGroupedByResource()
      For responses, this returns true if the service returned a value for the GroupedByResource 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.

    • groupedByResource

      public final List<ResourceStatistics> groupedByResource()

      Represents a list of map of top resources with a count of total findings.

      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 hasGroupedByResource() method.

      Returns:
      Represents a list of map of top resources with a count of total findings.

    • hasGroupedBySeverity

      public final boolean hasGroupedBySeverity()
      For responses, this returns true if the service returned a value for the GroupedBySeverity 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.

    • groupedBySeverity

      public final List<SeverityStatistics> groupedBySeverity()

      Represents a list of map of total findings for each severity level.

      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 hasGroupedBySeverity() method.

      Returns:
      Represents a list of map of total findings for each severity level.

    • toBuilder

      public FindingStatistics.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<FindingStatistics.Builder,FindingStatistics>
      Returns:
      a builder for type T

    • builder

      public static FindingStatistics.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FindingStatistics.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.