Package software.amazon.awssdk.services.codegurusecurity.model

Class Vulnerability

java.lang.Object

software.amazon.awssdk.services.codegurusecurity.model.Vulnerability

All Implemented Interfaces:

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

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

Information about a security vulnerability that Amazon CodeGuru Security detected.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Vulnerability.Builder

Method Summary

Modifier and Type	Method	Description
static Vulnerability.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FilePath	filePath()	An object that describes the location of the detected security vulnerability in your code.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasReferenceUrls()	For responses, this returns true if the service returned a value for the ReferenceUrls property.
boolean	hasRelatedVulnerabilities()	For responses, this returns true if the service returned a value for the RelatedVulnerabilities property.
String	id()	The identifier for the vulnerability.
Integer	itemCount()	The number of times the vulnerability appears in your code.
List<String>	referenceUrls()	One or more URL addresses that contain details about a vulnerability.
List<String>	relatedVulnerabilities()	One or more vulnerabilities that are related to the vulnerability being described.
List<SdkField<?>>	sdkFields()
static Class<? extends Vulnerability.Builder>	serializableBuilderClass()
Vulnerability.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

filePath

public final FilePath filePath()

An object that describes the location of the detected security vulnerability in your code.

Returns:

An object that describes the location of the detected security vulnerability in your code.

id

public final String id()

The identifier for the vulnerability.

Returns:

The identifier for the vulnerability.

itemCount

public final Integer itemCount()

The number of times the vulnerability appears in your code.

Returns:

The number of times the vulnerability appears in your code.

hasReferenceUrls

public final boolean hasReferenceUrls()

For responses, this returns true if the service returned a value for the ReferenceUrls 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.

referenceUrls

public final List<String> referenceUrls()

One or more URL addresses that contain details about a vulnerability.

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

Returns:

One or more URL addresses that contain details about a vulnerability.

hasRelatedVulnerabilities

public final boolean hasRelatedVulnerabilities()

For responses, this returns true if the service returned a value for the RelatedVulnerabilities 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.

relatedVulnerabilities

public final List<String> relatedVulnerabilities()

One or more vulnerabilities that are related to the vulnerability being described.

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

Returns:

One or more vulnerabilities that are related to the vulnerability being described.

toBuilder

public Vulnerability.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Vulnerability.Builder,Vulnerability>

builder

public static Vulnerability.Builder builder()

serializableBuilderClass

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