Interface PentestJob.Builder

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

  • Method Details

    • pentestJobId

      PentestJob.Builder pentestJobId(String pentestJobId)

      The unique identifier of the pentest job.

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

    • pentestId

      PentestJob.Builder pentestId(String pentestId)

      The unique identifier of the pentest associated with the job.

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

    • title

      PentestJob.Builder title(String title)

      The title of the pentest job.

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

    • overview

      PentestJob.Builder overview(String overview)

      An overview of the pentest job results.

      Parameters:
      overview - An overview of the pentest job results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      PentestJob.Builder status(String status)

      The current status of the pentest job.

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

    • status

      PentestJob.Builder status(JobStatus status)

      The current status of the pentest job.

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

    • endpoints

      PentestJob.Builder endpoints(Collection<Endpoint> endpoints)

      The list of endpoints being tested in the pentest job.

      Parameters:
      endpoints - The list of endpoints being tested in the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpoints

      PentestJob.Builder endpoints(Endpoint... endpoints)

      The list of endpoints being tested in the pentest job.

      Parameters:
      endpoints - The list of endpoints being tested in the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpoints

      PentestJob.Builder endpoints(Consumer<Endpoint.Builder>... endpoints)

      The list of endpoints being tested in the pentest job.

      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 endpoints(List<Endpoint>).

      Parameters:
      endpoints - 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:

    • actors

      PentestJob.Builder actors(Collection<Actor> actors)

      The list of actors used during the pentest job.

      Parameters:
      actors - The list of actors used during the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actors

      PentestJob.Builder actors(Actor... actors)

      The list of actors used during the pentest job.

      Parameters:
      actors - The list of actors used during the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actors

      PentestJob.Builder actors(Consumer<Actor.Builder>... actors)

      The list of actors used during the pentest job.

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

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

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

    • documents

      PentestJob.Builder documents(Collection<DocumentInfo> documents)

      The list of documents providing context for the pentest job.

      Parameters:
      documents - The list of documents providing context for the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documents

      PentestJob.Builder documents(DocumentInfo... documents)

      The list of documents providing context for the pentest job.

      Parameters:
      documents - The list of documents providing context for the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documents

      PentestJob.Builder documents(Consumer<DocumentInfo.Builder>... documents)

      The list of documents providing context for the pentest job.

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

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

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

    • sourceCode

      PentestJob.Builder sourceCode(Collection<SourceCodeRepository> sourceCode)

      The list of source code repositories analyzed during the pentest job.

      Parameters:
      sourceCode - The list of source code repositories analyzed during the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceCode

      PentestJob.Builder sourceCode(SourceCodeRepository... sourceCode)

      The list of source code repositories analyzed during the pentest job.

      Parameters:
      sourceCode - The list of source code repositories analyzed during the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceCode

      PentestJob.Builder sourceCode(Consumer<SourceCodeRepository.Builder>... sourceCode)

      The list of source code repositories analyzed during the pentest job.

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

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

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

    • excludePaths

      PentestJob.Builder excludePaths(Collection<Endpoint> excludePaths)

      The list of paths excluded from the pentest job.

      Parameters:
      excludePaths - The list of paths excluded from the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • excludePaths

      PentestJob.Builder excludePaths(Endpoint... excludePaths)

      The list of paths excluded from the pentest job.

      Parameters:
      excludePaths - The list of paths excluded from the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • excludePaths

      PentestJob.Builder excludePaths(Consumer<Endpoint.Builder>... excludePaths)

      The list of paths excluded from the pentest job.

      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 excludePaths(List<Endpoint>).

      Parameters:
      excludePaths - 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:

    • allowedDomains

      PentestJob.Builder allowedDomains(Collection<Endpoint> allowedDomains)

      The list of domains allowed during the pentest job.

      Parameters:
      allowedDomains - The list of domains allowed during the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • allowedDomains

      PentestJob.Builder allowedDomains(Endpoint... allowedDomains)

      The list of domains allowed during the pentest job.

      Parameters:
      allowedDomains - The list of domains allowed during the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • allowedDomains

      PentestJob.Builder allowedDomains(Consumer<Endpoint.Builder>... allowedDomains)

      The list of domains allowed during the pentest job.

      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 allowedDomains(List<Endpoint>).

      Parameters:
      allowedDomains - 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:

    • excludeRiskTypesWithStrings

      PentestJob.Builder excludeRiskTypesWithStrings(Collection<String> excludeRiskTypes)

      The list of risk types excluded from the pentest job.

      Parameters:
      excludeRiskTypes - The list of risk types excluded from the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • excludeRiskTypesWithStrings

      PentestJob.Builder excludeRiskTypesWithStrings(String... excludeRiskTypes)

      The list of risk types excluded from the pentest job.

      Parameters:
      excludeRiskTypes - The list of risk types excluded from the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • excludeRiskTypes

      PentestJob.Builder excludeRiskTypes(Collection<RiskType> excludeRiskTypes)

      The list of risk types excluded from the pentest job.

      Parameters:
      excludeRiskTypes - The list of risk types excluded from the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • excludeRiskTypes

      PentestJob.Builder excludeRiskTypes(RiskType... excludeRiskTypes)

      The list of risk types excluded from the pentest job.

      Parameters:
      excludeRiskTypes - The list of risk types excluded from the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • steps

      PentestJob.Builder steps(Collection<Step> steps)

      The list of steps in the pentest job execution.

      Parameters:
      steps - The list of steps in the pentest job execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • steps

      PentestJob.Builder steps(Step... steps)

      The list of steps in the pentest job execution.

      Parameters:
      steps - The list of steps in the pentest job execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • steps

      PentestJob.Builder steps(Consumer<Step.Builder>... steps)

      The list of steps in the pentest job execution.

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

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

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

    • executionContext

      PentestJob.Builder executionContext(Collection<ExecutionContext> executionContext)

      The execution context messages for the pentest job.

      Parameters:
      executionContext - The execution context messages for the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionContext

      PentestJob.Builder executionContext(ExecutionContext... executionContext)

      The execution context messages for the pentest job.

      Parameters:
      executionContext - The execution context messages for the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionContext

      PentestJob.Builder executionContext(Consumer<ExecutionContext.Builder>... executionContext)

      The execution context messages for the pentest job.

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

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

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

    • serviceRole

      PentestJob.Builder serviceRole(String serviceRole)

      The IAM service role used for the pentest job.

      Parameters:
      serviceRole - The IAM service role used for the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logConfig

      PentestJob.Builder logConfig(CloudWatchLog logConfig)

      The CloudWatch Logs configuration for the pentest job.

      Parameters:
      logConfig - The CloudWatch Logs configuration for the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logConfig

      default PentestJob.Builder logConfig(Consumer<CloudWatchLog.Builder> logConfig)

      The CloudWatch Logs configuration for the pentest job.

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

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

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

    • vpcConfig

      PentestJob.Builder vpcConfig(VpcConfig vpcConfig)

      The VPC configuration for the pentest job.

      Parameters:
      vpcConfig - The VPC configuration for the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfig

      default PentestJob.Builder vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)

      The VPC configuration for the pentest job.

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

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

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

    • networkTrafficConfig

      PentestJob.Builder networkTrafficConfig(NetworkTrafficConfig networkTrafficConfig)

      The network traffic configuration for the pentest job.

      Parameters:
      networkTrafficConfig - The network traffic configuration for the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networkTrafficConfig

      default PentestJob.Builder networkTrafficConfig(Consumer<NetworkTrafficConfig.Builder> networkTrafficConfig)

      The network traffic configuration for the pentest job.

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

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

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

    • errorInformation

      PentestJob.Builder errorInformation(ErrorInformation errorInformation)

      Error information if the pentest job encountered an error.

      Parameters:
      errorInformation - Error information if the pentest job encountered an error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • errorInformation

      default PentestJob.Builder errorInformation(Consumer<ErrorInformation.Builder> errorInformation)

      Error information if the pentest job encountered an error.

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

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

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

    • integratedRepositories

      PentestJob.Builder integratedRepositories(Collection<IntegratedRepository> integratedRepositories)

      The list of integrated repositories associated with the pentest job.

      Parameters:
      integratedRepositories - The list of integrated repositories associated with the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • integratedRepositories

      PentestJob.Builder integratedRepositories(IntegratedRepository... integratedRepositories)

      The list of integrated repositories associated with the pentest job.

      Parameters:
      integratedRepositories - The list of integrated repositories associated with the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • integratedRepositories

      PentestJob.Builder integratedRepositories(Consumer<IntegratedRepository.Builder>... integratedRepositories)

      The list of integrated repositories associated with the pentest job.

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

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

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

    • codeRemediationStrategy

      PentestJob.Builder codeRemediationStrategy(String codeRemediationStrategy)

      The code remediation strategy for the pentest job.

      Parameters:
      codeRemediationStrategy - The code remediation strategy for the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • codeRemediationStrategy

      PentestJob.Builder codeRemediationStrategy(CodeRemediationStrategy codeRemediationStrategy)

      The code remediation strategy for the pentest job.

      Parameters:
      codeRemediationStrategy - The code remediation strategy for the pentest job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdAt

      PentestJob.Builder createdAt(Instant createdAt)

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

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

    • updatedAt

      PentestJob.Builder updatedAt(Instant updatedAt)

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

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