Package software.amazon.awssdk.services.securityhub.model

Class Workflow

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

Provides details about the status of the investigation into a finding.

See Also:

  • Method Details

    • status

      public final WorkflowStatus status()

      The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue.

      The allowed values are the following.

      • NEW - The initial state of a finding, before it is reviewed.

        Security Hub also resets the workflow status from NOTIFIED or RESOLVED to NEW in the following cases:

        • RecordState changes from ARCHIVED to ACTIVE.

        • ComplianceStatus changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE.

      • NOTIFIED - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.

      • SUPPRESSED - Indicates that you reviewed the finding and do not believe that any action is needed. The finding is no longer updated.

      • RESOLVED - The finding was reviewed and remediated and is now considered resolved.

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

      Returns:
      The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue.

      The allowed values are the following.

      • NEW - The initial state of a finding, before it is reviewed.

        Security Hub also resets the workflow status from NOTIFIED or RESOLVED to NEW in the following cases:

        • RecordState changes from ARCHIVED to ACTIVE.

        • ComplianceStatus changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE.

      • NOTIFIED - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.

      • SUPPRESSED - Indicates that you reviewed the finding and do not believe that any action is needed. The finding is no longer updated.

      • RESOLVED - The finding was reviewed and remediated and is now considered resolved.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue.

      The allowed values are the following.

      • NEW - The initial state of a finding, before it is reviewed.

        Security Hub also resets the workflow status from NOTIFIED or RESOLVED to NEW in the following cases:

        • RecordState changes from ARCHIVED to ACTIVE.

        • ComplianceStatus changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE.

      • NOTIFIED - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.

      • SUPPRESSED - Indicates that you reviewed the finding and do not believe that any action is needed. The finding is no longer updated.

      • RESOLVED - The finding was reviewed and remediated and is now considered resolved.

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

      Returns:
      The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue.

      The allowed values are the following.

      • NEW - The initial state of a finding, before it is reviewed.

        Security Hub also resets the workflow status from NOTIFIED or RESOLVED to NEW in the following cases:

        • RecordState changes from ARCHIVED to ACTIVE.

        • ComplianceStatus changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE.

      • NOTIFIED - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.

      • SUPPRESSED - Indicates that you reviewed the finding and do not believe that any action is needed. The finding is no longer updated.

      • RESOLVED - The finding was reviewed and remediated and is now considered resolved.

      See Also:

    • toBuilder

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

    • builder

      public static Workflow.Builder builder()

    • serializableBuilderClass

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