Class Finding
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Finding.Builder,
Finding>
Provides the details of a finding.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The unique identifier for the Amazon Web Services account that the finding applies to.final Boolean
archived()
Specifies whether the finding is archived (suppressed).static Finding.Builder
builder()
final FindingCategory
category()
The category of the finding.final String
The category of the finding.final ClassificationDetails
The details of a sensitive data finding.final Long
count()
The total number of occurrences of the finding.final Instant
The date and time, in UTC and extended ISO 8601 format, when Amazon Macie created the finding.final String
The description of the finding.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
id()
The unique identifier for the finding.final String
The Amazon Web Services partition that Amazon Macie created the finding in.final PolicyDetails
The details of a policy finding.final String
region()
The Amazon Web Services Region that Amazon Macie created the finding in.final ResourcesAffected
The resources that the finding applies to.final Boolean
sample()
Specifies whether the finding is a sample finding.final String
The version of the schema that was used to define the data structures in the finding.static Class
<? extends Finding.Builder> final Severity
severity()
The severity level and score for the finding.final String
title()
The brief description of the finding.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final FindingType
type()
The type of the finding.final String
The type of the finding.final Instant
The date and time, in UTC and extended ISO 8601 format, when Amazon Macie last updated the finding.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
Specifies whether the finding is archived (suppressed).
- Returns:
- Specifies whether the finding is archived (suppressed).
-
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 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:
-
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 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:
-
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
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
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
The description of the finding.
- Returns:
- The description of the finding.
-
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
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
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
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
The resources that the finding applies to.
- Returns:
- The resources that the finding applies to.
-
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
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
The severity level and score for the finding.
- Returns:
- The severity level and score for the finding.
-
title
The brief description of the finding.
- Returns:
- The brief description of the finding.
-
type
The type of the finding.
If the service returns an enum value that is not available in the current SDK version,
type
will returnFindingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the finding.
- See Also:
-
typeAsString
The type of the finding.
If the service returns an enum value that is not available in the current SDK version,
type
will returnFindingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the finding.
- See Also:
-
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
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 interfaceToCopyableBuilder<Finding.Builder,
Finding> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-