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

Class Finding

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

Provides the details of a finding.

See Also:

  • Method Details

    • accountId

      public final String accountId()

      The unique identifier for the Amazon Web Services account that the finding applies to. This is typically the account that owns the affected resource.

      Returns:
      The unique identifier for the Amazon Web Services account that the finding applies to. This is typically the account that owns the affected resource.

    • archived

      public final Boolean archived()

      Specifies whether the finding is archived (suppressed).

      Returns:
      Specifies whether the finding is archived (suppressed).

    • category

      public final FindingCategory category()

      The category of the finding. Possible values are: CLASSIFICATION, for a sensitive data finding; and, POLICY, for a policy finding.

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

      Returns:
      The category of the finding. Possible values are: CLASSIFICATION, for a sensitive data finding; and, POLICY, for a policy finding.
      See Also:

    • categoryAsString

      public final String categoryAsString()

      The category of the finding. Possible values are: CLASSIFICATION, for a sensitive data finding; and, POLICY, for a policy finding.

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

      Returns:
      The category of the finding. Possible values are: CLASSIFICATION, for a sensitive data finding; and, POLICY, for a policy finding.
      See Also:

    • classificationDetails

      public final ClassificationDetails classificationDetails()

      The details of a sensitive data finding. This value is null for a policy finding.

      Returns:
      The details of a sensitive data finding. This value is null for a policy finding.

    • count

      public final Long count()

      The total number of occurrences of the finding. For sensitive data findings, this value is always 1. All sensitive data findings are considered unique.

      Returns:
      The total number of occurrences of the finding. For sensitive data findings, this value is always 1. All sensitive data findings are considered unique.

    • createdAt

      public final Instant createdAt()

      The date and time, in UTC and extended ISO 8601 format, when Amazon Macie created the finding.

      Returns:
      The date and time, in UTC and extended ISO 8601 format, when Amazon Macie created the finding.

    • description

      public final String description()

      The description of the finding.

      Returns:
      The description of the finding.

    • id

      public final String id()

      The unique identifier for the finding. This is a random string that Amazon Macie generates and assigns to a finding when it creates the finding.

      Returns:
      The unique identifier for the finding. This is a random string that Amazon Macie generates and assigns to a finding when it creates the finding.

    • partition

      public final String partition()

      The Amazon Web Services partition that Amazon Macie created the finding in.

      Returns:
      The Amazon Web Services partition that Amazon Macie created the finding in.

    • policyDetails

      public final PolicyDetails policyDetails()

      The details of a policy finding. This value is null for a sensitive data finding.

      Returns:
      The details of a policy finding. This value is null for a sensitive data finding.

    • region

      public final String region()

      The Amazon Web Services Region that Amazon Macie created the finding in.

      Returns:
      The Amazon Web Services Region that Amazon Macie created the finding in.

    • resourcesAffected

      public final ResourcesAffected resourcesAffected()

      The resources that the finding applies to.

      Returns:
      The resources that the finding applies to.

    • sample

      public final Boolean sample()

      Specifies whether the finding is a sample finding. A sample finding is a finding that uses example data to demonstrate what a finding might contain.

      Returns:
      Specifies whether the finding is a sample finding. A sample finding is a finding that uses example data to demonstrate what a finding might contain.

    • schemaVersion

      public final String schemaVersion()

      The version of the schema that was used to define the data structures in the finding.

      Returns:
      The version of the schema that was used to define the data structures in the finding.

    • severity

      public final Severity severity()

      The severity level and score for the finding.

      Returns:
      The severity level and score for the finding.

    • title

      public final String title()

      The brief description of the finding.

      Returns:
      The brief description of the finding.

    • type

      public final FindingType type()

      The type of the finding.

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

      Returns:
      The type of the finding.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the finding.

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

      Returns:
      The type of the finding.
      See Also:

    • updatedAt

      public final Instant updatedAt()

      The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last updated the finding. For sensitive data findings, this value is the same as the value for the createdAt property. All sensitive data findings are considered new.

      Returns:
      The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last updated the finding. For sensitive data findings, this value is the same as the value for the createdAt property. All sensitive data findings are considered new.

    • toBuilder

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

    • builder

      public static Finding.Builder builder()

    • serializableBuilderClass

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