software.amazon.awssdk.services.inspector.model

Class Finding

java.lang.Object

software.amazon.awssdk.services.inspector.model.Finding

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Finding.Builder,Finding>

@Generated(value="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 and Description
static interface	Finding.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The ARN that specifies the finding.
AssetAttributes	assetAttributes() A collection of attributes of the host from which the finding is generated.
AssetType	assetType() The type of the host from which the finding is generated.
String	assetTypeAsString() The type of the host from which the finding is generated.
List<Attribute>	attributes() The system-defined attributes for the finding.
static Finding.Builder	builder()
Integer	confidence() This data element is currently not used.
Instant	createdAt() The time when the finding was generated.
String	description() The description of the finding.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The ID of the finding.
Boolean	indicatorOfCompromise() This data element is currently not used.
Double	numericSeverity() The numeric value of the finding severity.
String	recommendation() The recommendation for the finding.
Integer	schemaVersion() The schema version of this data type.
List<SdkField<?>>	sdkFields()
static Class<? extends Finding.Builder>	serializableBuilderClass()
String	service() The data element is set to "Inspector".
InspectorServiceAttributes	serviceAttributes() This data type is used in the Finding data type.
Severity	severity() The finding severity.
String	severityAsString() The finding severity.
String	title() The name of the finding.
Finding.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Instant	updatedAt() 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

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

arn

public String arn()

The ARN that specifies the finding.

Returns:

The ARN that specifies the finding.

schemaVersion

public Integer schemaVersion()

The schema version of this data type.

Returns:

The schema version of this data type.

service

public String service()

The data element is set to "Inspector".

Returns:

The data element is set to "Inspector".

serviceAttributes

public 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 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, assetType will return AssetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from assetTypeAsString().

Returns:

The type of the host from which the finding is generated.

See Also:

AssetType

assetTypeAsString

public 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, assetType will return AssetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from assetTypeAsString().

Returns:

The type of the host from which the finding is generated.

See Also:

AssetType

assetAttributes

public 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 String id()

The ID of the finding.

Returns:

The ID of the finding.

title

public String title()

The name of the finding.

Returns:

The name of the finding.

description

public String description()

The description of the finding.

Returns:

The description of the finding.

recommendation

public String recommendation()

The recommendation for the finding.

Returns:

The recommendation for the finding.

severity

public 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, severity will return Severity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from severityAsString().

Returns:

The finding severity. Values can be set to High, Medium, Low, and Informational.

See Also:

Severity

severityAsString

public 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, severity will return Severity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from severityAsString().

Returns:

The finding severity. Values can be set to High, Medium, Low, and Informational.

See Also:

Severity

numericSeverity

public Double numericSeverity()

The numeric value of the finding severity.

Returns:

The numeric value of the finding severity.

confidence

public Integer confidence()

This data element is currently not used.

Returns:

This data element is currently not used.

indicatorOfCompromise

public Boolean indicatorOfCompromise()

This data element is currently not used.

Returns:

This data element is currently not used.

attributes

public List<Attribute> attributes()

The system-defined attributes for the finding.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The system-defined attributes for the finding.

userAttributes

public 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.

Returns:

The user-defined attributes that are assigned to the finding.

createdAt

public Instant createdAt()

The time when the finding was generated.

Returns:

The time when the finding was generated.

updatedAt

public Instant updatedAt()

The time when AddAttributesToFindings is called.

Returns:

The time when AddAttributesToFindings is called.

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public 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.