Class ValidationEvidenceBody

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

Projected content for a VALIDATION_EVIDENCE artifact: the validation agent's durable proof of exploitability.

See Also:

  • Method Details

    • exploitable

      public final ExploitabilityVerdict exploitable()

      Exploitability verdict. Explicit UNCERTAIN replaces the producer's tri-state exploitable: true | false | null, so an absent verdict is never confused with a negative one.

      If the service returns an enum value that is not available in the current SDK version, exploitable will return ExploitabilityVerdict.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exploitableAsString().

      Returns:
      Exploitability verdict. Explicit UNCERTAIN replaces the producer's tri-state exploitable: true | false | null, so an absent verdict is never confused with a negative one.
      See Also:

    • exploitableAsString

      public final String exploitableAsString()

      Exploitability verdict. Explicit UNCERTAIN replaces the producer's tri-state exploitable: true | false | null, so an absent verdict is never confused with a negative one.

      If the service returns an enum value that is not available in the current SDK version, exploitable will return ExploitabilityVerdict.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exploitableAsString().

      Returns:
      Exploitability verdict. Explicit UNCERTAIN replaces the producer's tri-state exploitable: true | false | null, so an absent verdict is never confused with a negative one.
      See Also:

    • terminalStatus

      public final ValidationTerminalStatus terminalStatus()

      How the validation run ended. Absent when the producer reported a status with no mapping yet: the rest of the body still projects, so one unmapped enum never costs a customer the whole artifact.

      If the service returns an enum value that is not available in the current SDK version, terminalStatus will return ValidationTerminalStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from terminalStatusAsString().

      Returns:
      How the validation run ended. Absent when the producer reported a status with no mapping yet: the rest of the body still projects, so one unmapped enum never costs a customer the whole artifact.
      See Also:

    • terminalStatusAsString

      public final String terminalStatusAsString()

      How the validation run ended. Absent when the producer reported a status with no mapping yet: the rest of the body still projects, so one unmapped enum never costs a customer the whole artifact.

      If the service returns an enum value that is not available in the current SDK version, terminalStatus will return ValidationTerminalStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from terminalStatusAsString().

      Returns:
      How the validation run ended. Absent when the producer reported a status with no mapping yet: the rest of the body still projects, so one unmapped enum never costs a customer the whole artifact.
      See Also:

    • hasFlowVerdicts

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

    • flowVerdicts

      public final List<FlowVerdict> flowVerdicts()

      One verdict per attack flow assessed in the bundle.

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

      Returns:
      One verdict per attack flow assessed in the bundle.

    • hasAttackFlowsConfirmed

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

    • attackFlowsConfirmed

      public final List<String> attackFlowsConfirmed()

      Identifiers of attack flows upgraded to Confirmed provenance.

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

      Returns:
      Identifiers of attack flows upgraded to Confirmed provenance.

    • exploitArtifact

      public final ValidationExploitArtifact exploitArtifact()

      Concrete payload and its observed effect, when validation produced one by sending an HTTP request.

      Only an HTTP proof projects here. A validation agent that proves exploitability by RUNNING code against the repository projects executedProof, and one that proves it by reading the source projects sourceAnalysis. All three are mutually exclusive: at most one is present.

      Returns:
      Concrete payload and its observed effect, when validation produced one by sending an HTTP request.

      Only an HTTP proof projects here. A validation agent that proves exploitability by RUNNING code against the repository projects executedProof, and one that proves it by reading the source projects sourceAnalysis. All three are mutually exclusive: at most one is present.

    • executedProof

      public final ValidationExecutedProof executedProof()

      Proof the agent produced by executing code against the repository under test, with the output that execution produced.

      Returns:
      Proof the agent produced by executing code against the repository under test, with the output that execution produced.

    • sourceAnalysis

      public final ValidationSourceAnalysis sourceAnalysis()

      Proof the agent produced by reading the repository's source, with nothing built or run.

      Returns:
      Proof the agent produced by reading the repository's source, with nothing built or run.

    • hasPerFindingResults

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

    • perFindingResults

      public final List<PerFindingResult> perFindingResults()

      Per-finding breakdown for a multi-finding bundle. Absent for a single-finding bundle.

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

      Returns:
      Per-finding breakdown for a multi-finding bundle. Absent for a single-finding bundle.

    • toBuilder

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

    • builder

      public static ValidationEvidenceBody.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.