Class CodeVulnerabilityDetails

    • Method Detail

      • 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 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.
      • cwes

        public final List<String> 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.
      • detectorName

        public final String 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 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.
      • detectorTags

        public final List<String> 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

        public final CodeFilePath 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 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()

        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

        public final String 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

        public final String 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.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)