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)

      The unique identifier of the task.

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

    • pentestId

      Task.Builder pentestId(String pentestId)

      The unique identifier of the pentest associated with the task.

      Parameters:
      pentestId - The unique identifier of the pentest associated with the task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pentestJobId

      Task.Builder pentestJobId(String pentestJobId)

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

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

    • agentSpaceId

      Task.Builder agentSpaceId(String agentSpaceId)

      The unique identifier of the agent space.

      Parameters:
      agentSpaceId - The unique identifier of the agent space.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • title

      Task.Builder title(String title)

      The title of the task.

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

    • description

      Task.Builder description(String description)

      A description of the task.

      Parameters:
      description - A description of the task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • categories

      Task.Builder categories(Collection<Category> categories)

      The list of categories assigned to the task.

      Parameters:
      categories - The list of categories assigned to the task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • categories

      Task.Builder categories(Category... categories)

      The list of categories assigned to the task.

      Parameters:
      categories - The list of categories assigned to the task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • categories

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

      The list of categories assigned to the 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)

      The type of security risk the task is testing for.

      Parameters:
      riskType - The type of security risk the task is testing for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • riskType

      Task.Builder riskType(RiskType riskType)

      The type of security risk the task is testing for.

      Parameters:
      riskType - The type of security risk the task is testing for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • targetEndpoint

      Task.Builder targetEndpoint(Endpoint targetEndpoint)

      The target endpoint being tested by the task.

      Parameters:
      targetEndpoint - The target endpoint being tested by the task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetEndpoint

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

      The target endpoint being tested by the task.

      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)

      The current execution status of the task.

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

    • executionStatus

      Task.Builder executionStatus(TaskExecutionStatus executionStatus)

      The current execution status of the task.

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

    • logsLocation

      Task.Builder logsLocation(LogLocation logsLocation)

      The location of the task execution logs.

      Parameters:
      logsLocation - The location of the task execution logs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logsLocation

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

      The location of the task execution logs.

      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)

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

      Parameters:
      createdAt - The date and time the task was created, in UTC format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      Task.Builder updatedAt(Instant updatedAt)

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

      Parameters:
      updatedAt - The date and time the task was last updated, in UTC format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.