Interface Task.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Task.Builder,Task>, SdkBuilder<Task.Builder,Task>, SdkPojo
Enclosing class:
Task
@Mutable @NotThreadSafe public static interface Task.Builder extends SdkPojo, CopyableBuilder<Task.Builder,Task>

  • Method Details

    • taskId

      Task.Builder taskId(String taskId)

      Unique identifier for the task

      Parameters:
      taskId - Unique identifier for the task
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pentestId

      Task.Builder pentestId(String pentestId)

      Identifier of the parent pentest

      Parameters:
      pentestId - Identifier of the parent pentest
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pentestJobId

      Task.Builder pentestJobId(String pentestJobId)

      Identifier of the pentest job this task belongs to

      Parameters:
      pentestJobId - Identifier of the pentest job this task belongs to
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • agentSpaceId

      Task.Builder agentSpaceId(String agentSpaceId)

      Identifier of the agent space this task belongs to

      Parameters:
      agentSpaceId - Identifier of the agent space this task belongs to
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • title

      Task.Builder title(String title)

      Title or name of the task

      Parameters:
      title - Title or name of the task
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      Task.Builder description(String description)

      Detailed description of the task's purpose and scope

      Parameters:
      description - Detailed description of the task's purpose and scope
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • categories

      Task.Builder categories(Collection<Category> categories)

      List of categories associated with this task

      Parameters:
      categories - List of categories associated with this task
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • categories

      Task.Builder categories(Category... categories)

      List of categories associated with this task

      Parameters:
      categories - List of categories associated with this task
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • categories

      Task.Builder categories(Consumer<Category.Builder>... categories)

      List of categories associated with this task

      This is a convenience method that creates an instance of the Category.Builder avoiding the need to create one manually via Category.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to categories(List<Category>).

      Parameters:
      categories - a consumer that will call methods on Category.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • riskType

      Task.Builder riskType(String riskType)

      Type of security risk this task is designed to test

      Parameters:
      riskType - Type of security risk this task is designed to test
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • riskType

      Task.Builder riskType(RiskType riskType)

      Type of security risk this task is designed to test

      Parameters:
      riskType - Type of security risk this task is designed to test
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • targetEndpoint

      Task.Builder targetEndpoint(Endpoint targetEndpoint)

      Target endpoint for this security test

      Parameters:
      targetEndpoint - Target endpoint for this security test
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetEndpoint

      default Task.Builder targetEndpoint(Consumer<Endpoint.Builder> targetEndpoint)

      Target endpoint for this security test

      This is a convenience method that creates an instance of the Endpoint.Builder avoiding the need to create one manually via Endpoint.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targetEndpoint(Endpoint).

      Parameters:
      targetEndpoint - a consumer that will call methods on Endpoint.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • executionStatus

      Task.Builder executionStatus(String executionStatus)

      Current status of the task execution

      Parameters:
      executionStatus - Current status of the task execution
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • executionStatus

      Task.Builder executionStatus(TaskExecutionStatus executionStatus)

      Current status of the task execution

      Parameters:
      executionStatus - Current status of the task execution
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logsLocation

      Task.Builder logsLocation(LogLocation logsLocation)

      Location of execution logs for auditing and review

      Parameters:
      logsLocation - Location of execution logs for auditing and review
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logsLocation

      default Task.Builder logsLocation(Consumer<LogLocation.Builder> logsLocation)

      Location of execution logs for auditing and review

      This is a convenience method that creates an instance of the LogLocation.Builder avoiding the need to create one manually via LogLocation.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to logsLocation(LogLocation).

      Parameters:
      logsLocation - a consumer that will call methods on LogLocation.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdAt

      Task.Builder createdAt(Instant createdAt)

      Timestamp when the task was created

      Parameters:
      createdAt - Timestamp when the task was created
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      Task.Builder updatedAt(Instant updatedAt)

      Timestamp when the task was last updated

      Parameters:
      updatedAt - Timestamp when the task was last updated
      Returns:
      Returns a reference to this object so that method calls can be chained together.