Class GetCodeIssueResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.continuum.model.ContinuumResponse
software.amazon.awssdk.services.continuum.model.GetCodeIssueResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetCodeIssueResponse.Builder,GetCodeIssueResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetCodeIssueResponse extends ContinuumResponse implements ToCopyableBuilder<GetCodeIssueResponse.Builder,GetCodeIssueResponse>

Contains the current state and details of the requested issue.

  • Method Details

    • issueId

      public final String issueId()

      The unique identifier of the issue.

      Returns:
      The unique identifier of the issue.

    • issueArn

      public final String issueArn()

      The ARN of the issue.

      Returns:
      The ARN of the issue.

    • name

      public final String name()

      The name of the issue.

      Returns:
      The name of the issue.

    • synopsis

      public final String synopsis()

      A free-form synopsis of the issue.

      Returns:
      A free-form synopsis of the issue.

    • severity

      public final IssueSeverity severity()

      Current severity: the FindingSeverity seed at create, overwritten by the authoritative severity that prioritization assigns after validation.

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

      Returns:
      Current severity: the FindingSeverity seed at create, overwritten by the authoritative severity that prioritization assigns after validation.
      See Also:

    • severityAsString

      public final String severityAsString()

      Current severity: the FindingSeverity seed at create, overwritten by the authoritative severity that prioritization assigns after validation.

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

      Returns:
      Current severity: the FindingSeverity seed at create, overwritten by the authoritative severity that prioritization assigns after validation.
      See Also:

    • confidence

      public final Integer confidence()

      The likelihood that this issue is a true positive, expressed as a percentage (0-100).

      Returns:
      The likelihood that this issue is a true positive, expressed as a percentage (0-100).

    • severityReasoning

      public final String severityReasoning()

      The justification for the current severity. Always leads with a customer-facing basis clause synthesized from how the severity was determined (e.g. "Severity from finding.", "Severity from Continuum system."); when prioritization has run, its own reasoning follows. Issues created before the basis clause was introduced return their original reasoning without it.

      Returns:
      The justification for the current severity. Always leads with a customer-facing basis clause synthesized from how the severity was determined (e.g. "Severity from finding.", "Severity from Continuum system."); when prioritization has run, its own reasoning follows. Issues created before the basis clause was introduced return their original reasoning without it.

    • summary

      public final String summary()

      The remediation completion summary, when the green stage has run.

      Returns:
      The remediation completion summary, when the green stage has run.

    • hasFindingIds

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

    • findingIds

      public final List<String> findingIds()

      The findings that motivated this issue. Bare identifiers only -- a caller authorized for GetCodeIssue is not necessarily authorized to read finding detail; call GetCodeFinding for that. Every referenced finding is included regardless of origin (both CustomerUploaded and ContinuumScanner).

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

      Returns:
      The findings that motivated this issue. Bare identifiers only -- a caller authorized for GetCodeIssue is not necessarily authorized to read finding detail; call GetCodeFinding for that. Every referenced finding is included regardless of origin (both CustomerUploaded and ContinuumScanner).

    • status

      public final IssueStatus status()

      The current lifecycle status of the issue.

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

      Returns:
      The current lifecycle status of the issue.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current lifecycle status of the issue.

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

      Returns:
      The current lifecycle status of the issue.
      See Also:

    • phase

      public final IssuePhase phase()

      The part of the workflow the issue is in. Present when status is IN_PROGRESS, and when status is FAILED and the failing phase is known.

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

      Returns:
      The part of the workflow the issue is in. Present when status is IN_PROGRESS, and when status is FAILED and the failing phase is known.
      See Also:

    • phaseAsString

      public final String phaseAsString()

      The part of the workflow the issue is in. Present when status is IN_PROGRESS, and when status is FAILED and the failing phase is known.

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

      Returns:
      The part of the workflow the issue is in. Present when status is IN_PROGRESS, and when status is FAILED and the failing phase is known.
      See Also:

    • statusReason

      public final IssueStatusReason statusReason()

      Why the issue failed. Present only when status is FAILED.

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

      Returns:
      Why the issue failed. Present only when status is FAILED.
      See Also:

    • statusReasonAsString

      public final String statusReasonAsString()

      Why the issue failed. Present only when status is FAILED.

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

      Returns:
      Why the issue failed. Present only when status is FAILED.
      See Also:

    • statusMessage

      public final String statusMessage()

      Customer-facing explanation of statusReason. Present only when status is FAILED.

      Returns:
      Customer-facing explanation of statusReason. Present only when status is FAILED.

    • statusUpdatedAt

      public final Instant statusUpdatedAt()

      The timestamp when the status or phase last changed.

      Returns:
      The timestamp when the status or phase last changed.

    • createdAt

      public final Instant createdAt()

      The timestamp when the issue was created.

      Returns:
      The timestamp when the issue was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when any field of the issue last changed. Advances on every mutation (including score-only updates that do not transition status), so it is greater than or equal to statusUpdatedAt.

      Returns:
      The timestamp when any field of the issue last changed. Advances on every mutation (including score-only updates that do not transition status), so it is greater than or equal to statusUpdatedAt.

    • evidenceAvailability

      public final IssueEvidenceAvailability evidenceAvailability()

      Whether the issue has any attached evidence (formerly 'artifacts': tool output, remediation proposals, patches). NONE = no evidence; AVAILABLE = at least one evidence item exists. Computed at read time.

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

      Returns:
      Whether the issue has any attached evidence (formerly 'artifacts': tool output, remediation proposals, patches). NONE = no evidence; AVAILABLE = at least one evidence item exists. Computed at read time.
      See Also:

    • evidenceAvailabilityAsString

      public final String evidenceAvailabilityAsString()

      Whether the issue has any attached evidence (formerly 'artifacts': tool output, remediation proposals, patches). NONE = no evidence; AVAILABLE = at least one evidence item exists. Computed at read time.

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

      Returns:
      Whether the issue has any attached evidence (formerly 'artifacts': tool output, remediation proposals, patches). NONE = no evidence; AVAILABLE = at least one evidence item exists. Computed at read time.
      See Also:

    • patchDelivery

      public final IssuePatchDelivery patchDelivery()

      Customer delivery of the issue's patches, summarized from its PATCH artifacts at read time. Absent when no patch has a destination delivery.

      Returns:
      Customer delivery of the issue's patches, summarized from its PATCH artifacts at read time. Absent when no patch has a destination delivery.

    • toBuilder

      public GetCodeIssueResponse.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<GetCodeIssueResponse.Builder,GetCodeIssueResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetCodeIssueResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetCodeIssueResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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