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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceFinding.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringaccountId()The unique identifier for the Amazon Web Services account that the finding applies to.Booleanarchived()Specifies whether the finding is archived (suppressed).static Finding.Builderbuilder()FindingCategorycategory()The category of the finding.StringcategoryAsString()The category of the finding.ClassificationDetailsclassificationDetails()The details of a sensitive data finding.Longcount()The total number of occurrences of the finding.InstantcreatedAt()The date and time, in UTC and extended ISO 8601 format, when Amazon Macie created the finding.Stringdescription()The description of the finding.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringid()The unique identifier for the finding.Stringpartition()The Amazon Web Services partition that Amazon Macie created the finding in.PolicyDetailspolicyDetails()The details of a policy finding.Stringregion()The Amazon Web Services Region that Amazon Macie created the finding in.ResourcesAffectedresourcesAffected()The resources that the finding applies to.Booleansample()Specifies whether the finding is a sample finding.StringschemaVersion()The version of the schema that was used to define the data structures in the finding.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends Finding.Builder>serializableBuilderClass()Severityseverity()The severity level and score for the finding.Stringtitle()The brief description of the finding.Finding.BuildertoBuilder()StringtoString()Returns a string representation of this object.FindingTypetype()The type of the finding.StringtypeAsString()The type of the finding.InstantupdatedAt()The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last updated the finding.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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,
categorywill returnFindingCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcategoryAsString().- Returns:
- The category of the finding. Possible values are: CLASSIFICATION, for a sensitive data finding; and, POLICY, for a policy finding.
- See Also:
FindingCategory
-
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,
categorywill returnFindingCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcategoryAsString().- Returns:
- The category of the finding. Possible values are: CLASSIFICATION, for a sensitive data finding; and, POLICY, for a policy finding.
- See Also:
FindingCategory
-
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,
typewill returnFindingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The type of the finding.
- See Also:
FindingType
-
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,
typewill returnFindingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The type of the finding.
- See Also:
FindingType
-
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Finding.Builder,Finding>
-
builder
public static Finding.Builder builder()
-
serializableBuilderClass
public static Class<? extends Finding.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-