Package software.amazon.awssdk.services.inspector2.model

Class CodeSnippetResult

java.lang.Object
software.amazon.awssdk.services.inspector2.model.CodeSnippetResult
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CodeSnippetResult.Builder,CodeSnippetResult>
@Generated("software.amazon.awssdk:codegen") public final class CodeSnippetResult extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CodeSnippetResult.Builder,CodeSnippetResult>

Contains information on a code snippet retrieved by Amazon Inspector from a code vulnerability finding.

See Also:

  • Method Details

    • hasCodeSnippet

      public final boolean hasCodeSnippet()
      For responses, this returns true if the service returned a value for the CodeSnippet 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.

    • codeSnippet

      public final List<CodeLine> codeSnippet()

      Contains information on the retrieved code snippet.

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

      Returns:
      Contains information on the retrieved code snippet.

    • endLine

      public final Integer endLine()

      The line number of the last line of a code snippet.

      Returns:
      The line number of the last line of a code snippet.

    • findingArn

      public final String findingArn()

      The ARN of a finding that the code snippet is associated with.

      Returns:
      The ARN of a finding that the code snippet is associated with.

    • startLine

      public final Integer startLine()

      The line number of the first line of a code snippet.

      Returns:
      The line number of the first line of a code snippet.

    • hasSuggestedFixes

      public final boolean hasSuggestedFixes()
      For responses, this returns true if the service returned a value for the SuggestedFixes 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.

    • suggestedFixes

      public final List<SuggestedFix> suggestedFixes()

      Details of a suggested code fix.

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

      Returns:
      Details of a suggested code fix.

    • toBuilder

      public CodeSnippetResult.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<CodeSnippetResult.Builder,CodeSnippetResult>
      Returns:
      a builder for type T

    • builder

      public static CodeSnippetResult.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CodeSnippetResult.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.