Class FindingProviderSeverity

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

The severity assigned to a finding by the finding provider. This object may include one or more of the following attributes:

  • Label

  • Normalized

  • Original

  • Product

If a BatchImportFindings request for a new finding only provides Label or only provides Normalized, Security Hub automatically populates the value of the other field.

The Normalized and Product attributes are included in the FindingProviderSeverity structure to preserve the historical information associated with the finding, even if the top-level Severity object is later modified using the BatchUpdateFindings operation.

If the top-level Finding.Severity object is present, but Finding.FindingProviderFields isn't present, Security Hub creates the FindingProviderFields.Severity object and copies the entire Finding.Severity object into it. This ensures that the original, provider-supplied details are retained within the FindingProviderFields.Severity object, even if the top-level Severity object is overwritten.

See Also:

  • Method Details

    • label

      public final SeverityLabel label()

      The severity label assigned to the finding by the finding provider.

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

      Returns:
      The severity label assigned to the finding by the finding provider.
      See Also:

    • labelAsString

      public final String labelAsString()

      The severity label assigned to the finding by the finding provider.

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

      Returns:
      The severity label assigned to the finding by the finding provider.
      See Also:

    • original

      public final String original()

      The finding provider's original value for the severity.

      Length Constraints: Minimum length of 1. Maximum length of 64.

      Returns:
      The finding provider's original value for the severity.

      Length Constraints: Minimum length of 1. Maximum length of 64.

    • toBuilder

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

    • builder

      public static FindingProviderSeverity.Builder builder()

    • serializableBuilderClass

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