Class CodeVulnerabilityDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CodeVulnerabilityDetails.Builder,
CodeVulnerabilityDetails>
Contains information on the code vulnerability identified in your Lambda function.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
cwes()
The Common Weakness Enumeration (CWE) item associated with the detected vulnerability.final String
The ID for the Amazon CodeGuru detector associated with the finding.final String
The name of the detector used to identify the code vulnerability.The detector tag associated with the vulnerability.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final CodeFilePath
filePath()
Contains information on where the code vulnerability is located in your code.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
hasCwes()
For responses, this returns true if the service returned a value for the Cwes property.final boolean
For responses, this returns true if the service returned a value for the DetectorTags property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ReferenceUrls property.A URL containing supporting documentation about the code vulnerability detected.final String
ruleId()
The identifier for a rule that was used to detect the code vulnerability.static Class
<? extends CodeVulnerabilityDetails.Builder> final String
The Amazon Resource Name (ARN) of the Lambda layer that the code vulnerability was detected in.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasCwes
public final boolean hasCwes()For responses, this returns true if the service returned a value for the Cwes 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. -
cwes
The Common Weakness Enumeration (CWE) item associated with the detected 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
hasCwes()
method.- Returns:
- The Common Weakness Enumeration (CWE) item associated with the detected vulnerability.
-
detectorId
The ID for the Amazon CodeGuru detector associated with the finding. For more information on detectors see Amazon CodeGuru Detector Library.
- Returns:
- The ID for the Amazon CodeGuru detector associated with the finding. For more information on detectors see Amazon CodeGuru Detector Library.
-
detectorName
The name of the detector used to identify the code vulnerability. For more information on detectors see CodeGuru Detector Library.
- Returns:
- The name of the detector used to identify the code vulnerability. For more information on detectors see CodeGuru Detector Library.
-
hasDetectorTags
public final boolean hasDetectorTags()For responses, this returns true if the service returned a value for the DetectorTags 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. -
detectorTags
The detector tag associated with the vulnerability. Detector tags group related vulnerabilities by common themes or tactics. For a list of available tags by programming language, see Java tags, or Python tags.
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
hasDetectorTags()
method.- Returns:
- The detector tag associated with the vulnerability. Detector tags group related vulnerabilities by common themes or tactics. For a list of available tags by programming language, see Java tags, or Python tags.
-
filePath
Contains information on where the code vulnerability is located in your code.
- Returns:
- Contains information on where the code vulnerability is located 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 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. -
referenceUrls
A URL containing supporting documentation about the code vulnerability detected.
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:
- A URL containing supporting documentation about the code vulnerability detected.
-
ruleId
The identifier for a rule that was used to detect the code vulnerability.
- Returns:
- The identifier for a rule that was used to detect the code vulnerability.
-
sourceLambdaLayerArn
The Amazon Resource Name (ARN) of the Lambda layer that the code vulnerability was detected in.
- Returns:
- The Amazon Resource Name (ARN) of the Lambda layer that the code vulnerability was detected in.
-
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<CodeVulnerabilityDetails.Builder,
CodeVulnerabilityDetails> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
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
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-