Package software.amazon.awssdk.services.securityhub.model

Class Threat

java.lang.Object

software.amazon.awssdk.services.securityhub.model.Threat

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class Threat
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Threat.Builder,Threat>

Provides information about the threat detected in a security finding and the file paths that were affected by the threat.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Threat.Builder

Method Summary

Modifier and Type	Method	Description
static Threat.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<FilePaths>	filePaths()	Provides information about the file paths that were affected by the threat.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilePaths()	For responses, this returns true if the service returned a value for the FilePaths property.
int	hashCode()
Integer	itemCount()	This total number of items in which the threat has been detected.
String	name()	The name of the threat.
List<SdkField<?>>	sdkFields()
static Class<? extends Threat.Builder>	serializableBuilderClass()
String	severity()	The severity of the threat.
Threat.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

name

public final String name()

The name of the threat.

Length Constraints: Minimum of 1 length. Maximum of 128 length.

Returns:

The name of the threat.

Length Constraints: Minimum of 1 length. Maximum of 128 length.

severity

public final String severity()

The severity of the threat.

Length Constraints: Minimum of 1 length. Maximum of 128 length.

Returns:

The severity of the threat.

Length Constraints: Minimum of 1 length. Maximum of 128 length.

itemCount

public final Integer itemCount()

This total number of items in which the threat has been detected.

Returns:

This total number of items in which the threat has been detected.

hasFilePaths

public final boolean hasFilePaths()

For responses, this returns true if the service returned a value for the FilePaths property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

filePaths

public final List<FilePaths> filePaths()

Provides information about the file paths that were affected by the threat.

Array Members: Minimum number of 1 item. Maximum number of 5 items.

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 hasFilePaths() method.

Returns:

Provides information about the file paths that were affected by the threat.

Array Members: Minimum number of 1 item. Maximum number of 5 items.

toBuilder

public Threat.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Threat.Builder,Threat>

builder

public static Threat.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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