Package software.amazon.awssdk.services.macie2.model

Class ClassificationResult

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

Provides the details of a sensitive data finding, including the types, number of occurrences, and locations of the sensitive data that was detected.

See Also:

  • Method Details

    • additionalOccurrences

      public final Boolean additionalOccurrences()

      Specifies whether Amazon Macie detected additional occurrences of sensitive data in the S3 object. A finding includes location data for a maximum of 15 occurrences of sensitive data.

      This value can help you determine whether to investigate additional occurrences of sensitive data in an object. You can do this by referring to the corresponding sensitive data discovery result for the finding (classificationDetails.detailedResultsLocation).

      Returns:
      Specifies whether Amazon Macie detected additional occurrences of sensitive data in the S3 object. A finding includes location data for a maximum of 15 occurrences of sensitive data.

      This value can help you determine whether to investigate additional occurrences of sensitive data in an object. You can do this by referring to the corresponding sensitive data discovery result for the finding (classificationDetails.detailedResultsLocation).

    • customDataIdentifiers

      public final CustomDataIdentifiers customDataIdentifiers()

      The custom data identifiers that detected the sensitive data and the number of occurrences of the data that they detected.

      Returns:
      The custom data identifiers that detected the sensitive data and the number of occurrences of the data that they detected.

    • mimeType

      public final String mimeType()

      The type of content, as a MIME type, that the finding applies to. For example, application/gzip, for a GNU Gzip compressed archive file, or application/pdf, for an Adobe Portable Document Format file.

      Returns:
      The type of content, as a MIME type, that the finding applies to. For example, application/gzip, for a GNU Gzip compressed archive file, or application/pdf, for an Adobe Portable Document Format file.

    • hasSensitiveData

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

    • sensitiveData

      public final List<SensitiveDataItem> sensitiveData()

      The category, types, and number of occurrences of the sensitive data that produced the finding.

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

      Returns:
      The category, types, and number of occurrences of the sensitive data that produced the finding.

    • sizeClassified

      public final Long sizeClassified()

      The total size, in bytes, of the data that the finding applies to.

      Returns:
      The total size, in bytes, of the data that the finding applies to.

    • status

      public final ClassificationResultStatus status()

      The status of the finding.

      Returns:
      The status of the finding.

    • toBuilder

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

    • builder

      public static ClassificationResult.Builder builder()

    • serializableBuilderClass

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