Class ThreatModelJob

java.lang.Object
software.amazon.awssdk.services.securityagent.model.ThreatModelJob
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ThreatModelJob.Builder,ThreatModelJob>
@Generated("software.amazon.awssdk:codegen") public final class ThreatModelJob extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ThreatModelJob.Builder,ThreatModelJob>

Represents a threat model job, which is an execution instance of a threat model.

See Also:

  • Method Details

    • threatModelJobId

      public final String threatModelJobId()

      The unique identifier of the threat model job.

      Returns:
      The unique identifier of the threat model job.

    • threatModelId

      public final String threatModelId()

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

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

    • 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 threat model job.

      Returns:
      The title of the threat model job.

    • status

      public final JobStatus status()

      The current status of the threat model job.

      If the service returns an enum value that is not available in the current SDK version, status will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the threat model job.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the threat model job.

      If the service returns an enum value that is not available in the current SDK version, status will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the threat model job.
      See Also:

    • createdAt

      public final Instant createdAt()

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

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

    • updatedAt

      public final Instant updatedAt()

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

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

    • executionStartTime

      public final Instant executionStartTime()

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

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

    • executionEndTime

      public final Instant executionEndTime()

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

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

    • hasSourceCode

      public final boolean hasSourceCode()
      For responses, this returns true if the service returned a value for the SourceCode 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.

    • sourceCode

      public final List<SourceCodeRepository> sourceCode()

      The list of source code repositories used for threat modeling.

      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 hasSourceCode() method.

      Returns:
      The list of source code repositories used for threat modeling.

    • hasIntegratedRepositories

      public final boolean hasIntegratedRepositories()
      For responses, this returns true if the service returned a value for the IntegratedRepositories 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.

    • integratedRepositories

      public final List<IntegratedRepository> integratedRepositories()

      The list of integrated repositories used for threat modeling.

      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 hasIntegratedRepositories() method.

      Returns:
      The list of integrated repositories used for threat modeling.

    • hasDocuments

      public final boolean hasDocuments()
      For responses, this returns true if the service returned a value for the Documents 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.

    • documents

      public final List<DocumentInfo> documents()

      The list of documents used for threat modeling.

      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 hasDocuments() method.

      Returns:
      The list of documents used for threat modeling.

    • hasScopeDocs

      public final boolean hasScopeDocs()
      For responses, this returns true if the service returned a value for the ScopeDocs 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.

    • scopeDocs

      public final List<DocumentInfo> scopeDocs()

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

      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 hasScopeDocs() method.

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

    • errorInformation

      public final ErrorInformation errorInformation()

      Error information if the threat model job encountered an error.

      Returns:
      Error information if the threat model job encountered an error.

    • systemOverview

      public final String systemOverview()

      The system overview generated during threat modeling.

      Returns:
      The system overview generated during threat modeling.

    • toBuilder

      public ThreatModelJob.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<ThreatModelJob.Builder,ThreatModelJob>
      Returns:
      a builder for type T

    • builder

      public static ThreatModelJob.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ThreatModelJob.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.