Class SensitiveDataResult

java.lang.Object
software.amazon.awssdk.services.securityhub.model.SensitiveDataResult
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SensitiveDataResult.Builder,SensitiveDataResult>

@Generated("software.amazon.awssdk:codegen") public final class SensitiveDataResult extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SensitiveDataResult.Builder,SensitiveDataResult>

Contains a detected instance of sensitive data that are based on built-in identifiers.

See Also:
  • Method Details

    • category

      public final String category()

      The category of sensitive data that was detected. For example, the category can indicate that the sensitive data involved credentials, financial information, or personal information.

      Returns:
      The category of sensitive data that was detected. For example, the category can indicate that the sensitive data involved credentials, financial information, or personal information.
    • hasDetections

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

      public final List<SensitiveDataDetections> detections()

      The list of detected instances of sensitive data.

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

      Returns:
      The list of detected instances of sensitive data.
    • totalCount

      public final Long totalCount()

      The total number of occurrences of sensitive data.

      Returns:
      The total number of occurrences of sensitive data.
    • toBuilder

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

      public static SensitiveDataResult.Builder builder()
    • serializableBuilderClass

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