Interface ThreatModelJob.Builder

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

  • Method Details

    • threatModelJobId

      ThreatModelJob.Builder threatModelJobId(String threatModelJobId)

      The unique identifier of the threat model job.

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

    • threatModelId

      ThreatModelJob.Builder threatModelId(String threatModelId)

      The unique identifier of the threat model associated with the job.

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

    • agentSpaceId

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

      ThreatModelJob.Builder title(String title)

      The title of the threat model job.

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

    • status

      ThreatModelJob.Builder status(String status)

      The current status of the threat model job.

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

    • status

      ThreatModelJob.Builder status(JobStatus status)

      The current status of the threat model job.

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

    • createdAt

      ThreatModelJob.Builder createdAt(Instant createdAt)

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

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

    • updatedAt

      ThreatModelJob.Builder updatedAt(Instant updatedAt)

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

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

    • executionStartTime

      ThreatModelJob.Builder executionStartTime(Instant executionStartTime)

      The date and time the threat model job execution started, in UTC format.

      Parameters:
      executionStartTime - The date and time the threat model job execution started, in UTC format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • executionEndTime

      ThreatModelJob.Builder executionEndTime(Instant executionEndTime)

      The date and time the threat model job execution ended, in UTC format.

      Parameters:
      executionEndTime - The date and time the threat model job execution ended, in UTC format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceCode

      ThreatModelJob.Builder sourceCode(Collection<SourceCodeRepository> sourceCode)

      The list of source code repositories used for threat modeling.

      Parameters:
      sourceCode - The list of source code repositories used for threat modeling.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceCode

      ThreatModelJob.Builder sourceCode(SourceCodeRepository... sourceCode)

      The list of source code repositories used for threat modeling.

      Parameters:
      sourceCode - The list of source code repositories used for threat modeling.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceCode

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

      The list of source code repositories used for threat modeling.

      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:

    • integratedRepositories

      ThreatModelJob.Builder integratedRepositories(Collection<IntegratedRepository> integratedRepositories)

      The list of integrated repositories used for threat modeling.

      Parameters:
      integratedRepositories - The list of integrated repositories used for threat modeling.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • integratedRepositories

      ThreatModelJob.Builder integratedRepositories(IntegratedRepository... integratedRepositories)

      The list of integrated repositories used for threat modeling.

      Parameters:
      integratedRepositories - The list of integrated repositories used for threat modeling.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • integratedRepositories

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

      The list of integrated repositories used for threat modeling.

      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:

    • documents

      ThreatModelJob.Builder documents(Collection<DocumentInfo> documents)

      The list of documents used for threat modeling.

      Parameters:
      documents - The list of documents used for threat modeling.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documents

      ThreatModelJob.Builder documents(DocumentInfo... documents)

      The list of documents used for threat modeling.

      Parameters:
      documents - The list of documents used for threat modeling.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documents

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

      The list of documents used for threat modeling.

      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:

    • scopeDocs

      ThreatModelJob.Builder scopeDocs(Collection<DocumentInfo> scopeDocs)

      The scoped documents for the agent to focus on during threat modeling.

      Parameters:
      scopeDocs - The scoped documents for the agent to focus on during threat modeling.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopeDocs

      ThreatModelJob.Builder scopeDocs(DocumentInfo... scopeDocs)

      The scoped documents for the agent to focus on during threat modeling.

      Parameters:
      scopeDocs - The scoped documents for the agent to focus on during threat modeling.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopeDocs

      ThreatModelJob.Builder scopeDocs(Consumer<DocumentInfo.Builder>... scopeDocs)

      The scoped documents for the agent to focus on during threat modeling.

      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 scopeDocs(List<DocumentInfo>).

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

    • errorInformation

      ThreatModelJob.Builder errorInformation(ErrorInformation errorInformation)

      Error information if the threat model job encountered an error.

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

    • errorInformation

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

      Error information if the threat model 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:

    • systemOverview

      ThreatModelJob.Builder systemOverview(String systemOverview)

      The system overview generated during threat modeling.

      Parameters:
      systemOverview - The system overview generated during threat modeling.
      Returns:
      Returns a reference to this object so that method calls can be chained together.