Class Task

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

Represents a task within a pentest job

See Also:

  • Method Details

    • taskId

      public final String taskId()

      Unique identifier for the task

      Returns:
      Unique identifier for the task

    • pentestId

      public final String pentestId()

      Identifier of the parent pentest

      Returns:
      Identifier of the parent pentest

    • pentestJobId

      public final String pentestJobId()

      Identifier of the pentest job this task belongs to

      Returns:
      Identifier of the pentest job this task belongs to

    • agentSpaceId

      public final String agentSpaceId()

      Identifier of the agent space this task belongs to

      Returns:
      Identifier of the agent space this task belongs to

    • title

      public final String title()

      Title or name of the task

      Returns:
      Title or name of the task

    • description

      public final String description()

      Detailed description of the task's purpose and scope

      Returns:
      Detailed description of the task's purpose and scope

    • hasCategories

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

    • categories

      public final List<Category> categories()

      List of categories associated with this task

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

      Returns:
      List of categories associated with this task

    • riskType

      public final RiskType riskType()

      Type of security risk this task is designed to test

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

      Returns:
      Type of security risk this task is designed to test
      See Also:

    • riskTypeAsString

      public final String riskTypeAsString()

      Type of security risk this task is designed to test

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

      Returns:
      Type of security risk this task is designed to test
      See Also:

    • targetEndpoint

      public final Endpoint targetEndpoint()

      Target endpoint for this security test

      Returns:
      Target endpoint for this security test

    • executionStatus

      public final TaskExecutionStatus executionStatus()

      Current status of the task execution

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

      Returns:
      Current status of the task execution
      See Also:

    • executionStatusAsString

      public final String executionStatusAsString()

      Current status of the task execution

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

      Returns:
      Current status of the task execution
      See Also:

    • logsLocation

      public final LogLocation logsLocation()

      Location of execution logs for auditing and review

      Returns:
      Location of execution logs for auditing and review

    • createdAt

      public final Instant createdAt()

      Timestamp when the task was created

      Returns:
      Timestamp when the task was created

    • updatedAt

      public final Instant updatedAt()

      Timestamp when the task was last updated

      Returns:
      Timestamp when the task was last updated

    • toBuilder

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

    • builder

      public static Task.Builder builder()

    • serializableBuilderClass

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