Class Finding
- java.lang.Object
-
- software.amazon.awssdk.services.inspector.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>
Contains information about an Amazon Inspector finding. This data type is used as the response element in the DescribeFindings action.
- 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 Stringarn()The ARN that specifies the finding.AssetAttributesassetAttributes()A collection of attributes of the host from which the finding is generated.AssetTypeassetType()The type of the host from which the finding is generated.StringassetTypeAsString()The type of the host from which the finding is generated.List<Attribute>attributes()The system-defined attributes for the finding.static Finding.Builderbuilder()Integerconfidence()This data element is currently not used.InstantcreatedAt()The time when the finding was generated.Stringdescription()The description of the finding.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAttributes()For responses, this returns true if the service returned a value for the Attributes property.inthashCode()booleanhasUserAttributes()For responses, this returns true if the service returned a value for the UserAttributes property.Stringid()The ID of the finding.BooleanindicatorOfCompromise()This data element is currently not used.DoublenumericSeverity()The numeric value of the finding severity.Stringrecommendation()The recommendation for the finding.IntegerschemaVersion()The schema version of this data type.List<SdkField<?>>sdkFields()static Class<? extends Finding.Builder>serializableBuilderClass()Stringservice()The data element is set to "Inspector".InspectorServiceAttributesserviceAttributes()This data type is used in the Finding data type.Severityseverity()The finding severity.StringseverityAsString()The finding severity.Stringtitle()The name of the finding.Finding.BuildertoBuilder()StringtoString()Returns a string representation of this object.InstantupdatedAt()The time when AddAttributesToFindings is called.List<Attribute>userAttributes()The user-defined attributes that are assigned to 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
-
arn
public final String arn()
The ARN that specifies the finding.
- Returns:
- The ARN that specifies the finding.
-
schemaVersion
public final Integer schemaVersion()
The schema version of this data type.
- Returns:
- The schema version of this data type.
-
service
public final String service()
The data element is set to "Inspector".
- Returns:
- The data element is set to "Inspector".
-
serviceAttributes
public final InspectorServiceAttributes serviceAttributes()
This data type is used in the Finding data type.
- Returns:
- This data type is used in the Finding data type.
-
assetType
public final AssetType assetType()
The type of the host from which the finding is generated.
If the service returns an enum value that is not available in the current SDK version,
assetTypewill returnAssetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromassetTypeAsString().- Returns:
- The type of the host from which the finding is generated.
- See Also:
AssetType
-
assetTypeAsString
public final String assetTypeAsString()
The type of the host from which the finding is generated.
If the service returns an enum value that is not available in the current SDK version,
assetTypewill returnAssetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromassetTypeAsString().- Returns:
- The type of the host from which the finding is generated.
- See Also:
AssetType
-
assetAttributes
public final AssetAttributes assetAttributes()
A collection of attributes of the host from which the finding is generated.
- Returns:
- A collection of attributes of the host from which the finding is generated.
-
id
public final String id()
The ID of the finding.
- Returns:
- The ID of the finding.
-
title
public final String title()
The name of the finding.
- Returns:
- The name of the finding.
-
description
public final String description()
The description of the finding.
- Returns:
- The description of the finding.
-
recommendation
public final String recommendation()
The recommendation for the finding.
- Returns:
- The recommendation for the finding.
-
severity
public final Severity severity()
The finding severity. Values can be set to High, Medium, Low, and Informational.
If the service returns an enum value that is not available in the current SDK version,
severitywill returnSeverity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromseverityAsString().- Returns:
- The finding severity. Values can be set to High, Medium, Low, and Informational.
- See Also:
Severity
-
severityAsString
public final String severityAsString()
The finding severity. Values can be set to High, Medium, Low, and Informational.
If the service returns an enum value that is not available in the current SDK version,
severitywill returnSeverity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromseverityAsString().- Returns:
- The finding severity. Values can be set to High, Medium, Low, and Informational.
- See Also:
Severity
-
numericSeverity
public final Double numericSeverity()
The numeric value of the finding severity.
- Returns:
- The numeric value of the finding severity.
-
confidence
public final Integer confidence()
This data element is currently not used.
- Returns:
- This data element is currently not used.
-
indicatorOfCompromise
public final Boolean indicatorOfCompromise()
This data element is currently not used.
- Returns:
- This data element is currently not used.
-
hasAttributes
public final boolean hasAttributes()
For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
attributes
public final List<Attribute> attributes()
The system-defined attributes for 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
hasAttributes()method.- Returns:
- The system-defined attributes for the finding.
-
hasUserAttributes
public final boolean hasUserAttributes()
For responses, this returns true if the service returned a value for the UserAttributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
userAttributes
public final List<Attribute> userAttributes()
The user-defined attributes that are assigned to 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
hasUserAttributes()method.- Returns:
- The user-defined attributes that are assigned to the finding.
-
createdAt
public final Instant createdAt()
The time when the finding was generated.
- Returns:
- The time when the finding was generated.
-
updatedAt
public final Instant updatedAt()
The time when AddAttributesToFindings is called.
- Returns:
- The time when AddAttributesToFindings is called.
-
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.
-
-