Class Step

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

Represents a step in the pentest job execution pipeline. Steps include preflight, static analysis, pentest, and finalizing.

See Also:

  • Method Details

    • name

      public final StepName name()

      The name of the step. Valid values include PREFLIGHT, STATIC_ANALYSIS, PENTEST, and FINALIZING.

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

      Returns:
      The name of the step. Valid values include PREFLIGHT, STATIC_ANALYSIS, PENTEST, and FINALIZING.
      See Also:

    • nameAsString

      public final String nameAsString()

      The name of the step. Valid values include PREFLIGHT, STATIC_ANALYSIS, PENTEST, and FINALIZING.

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

      Returns:
      The name of the step. Valid values include PREFLIGHT, STATIC_ANALYSIS, PENTEST, and FINALIZING.
      See Also:

    • status

      public final StepStatus status()

      The current status of the step.

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

      Returns:
      The current status of the step.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the step.

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

      Returns:
      The current status of the step.
      See Also:

    • createdAt

      public final Instant createdAt()

      The date and time the step was created, in UTC format.

      Returns:
      The date and time the step was created, in UTC format.

    • updatedAt

      public final Instant updatedAt()

      The date and time the step was last updated, in UTC format.

      Returns:
      The date and time the step was last updated, in UTC format.

    • toBuilder

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

    • builder

      public static Step.Builder builder()

    • serializableBuilderClass

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