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 an individual security test task within a pentest job. Each task targets a specific risk type or endpoint and executes independently.

See Also:

  • Method Details

    • taskId

      public final String taskId()

      The unique identifier of the task.

      Returns:
      The unique identifier of the task.

    • pentestId

      public final String pentestId()

      The unique identifier of the pentest associated with the task.

      Returns:
      The unique identifier of the pentest associated with the task.

    • pentestJobId

      public final String pentestJobId()

      The unique identifier of the pentest job that contains the task.

      Returns:
      The unique identifier of the pentest job that contains the task.

    • agentSpaceId

      public final String agentSpaceId()

      The unique identifier of the agent space.

      Returns:
      The unique identifier of the agent space.

    • title

      public final String title()

      The title of the task.

      Returns:
      The title of the task.

    • description

      public final String description()

      A description of the task.

      Returns:
      A description of the task.

    • 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()

      The list of categories assigned to the 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:
      The list of categories assigned to the task.

    • riskType

      public final RiskType riskType()

      The type of security risk the task is testing for.

      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:
      The type of security risk the task is testing for.
      See Also:

    • riskTypeAsString

      public final String riskTypeAsString()

      The type of security risk the task is testing for.

      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:
      The type of security risk the task is testing for.
      See Also:

    • targetEndpoint

      public final Endpoint targetEndpoint()

      The target endpoint being tested by the task.

      Returns:
      The target endpoint being tested by the task.

    • executionStatus

      public final TaskExecutionStatus executionStatus()

      The current execution status of the task.

      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:
      The current execution status of the task.
      See Also:

    • executionStatusAsString

      public final String executionStatusAsString()

      The current execution status of the task.

      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:
      The current execution status of the task.
      See Also:

    • logsLocation

      public final LogLocation logsLocation()

      The location of the task execution logs.

      Returns:
      The location of the task execution logs.

    • createdAt

      public final Instant createdAt()

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

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

    • updatedAt

      public final Instant updatedAt()

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

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

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