Class PentestJob

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

Represents a pentest job

See Also:

  • Method Details

    • pentestJobId

      public final String pentestJobId()

      Unique identifier of the pentest job

      Returns:
      Unique identifier of the pentest job

    • pentestId

      public final String pentestId()

      Identifier of the parent pentest

      Returns:
      Identifier of the parent pentest

    • title

      public final String title()

      Title or name of the pentest

      Returns:
      Title or name of the pentest

    • overview

      public final String overview()

      Overview or description of the pentest job

      Returns:
      Overview or description of the pentest job

    • status

      public final JobStatus status()

      Current status of the pentest 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:
      Current status of the pentest job
      See Also:

    • statusAsString

      public final String statusAsString()

      Current status of the pentest 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:
      Current status of the pentest job
      See Also:

    • hasEndpoints

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

    • endpoints

      public final List<Endpoint> endpoints()

      List of web application endpoints to test

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

      Returns:
      List of web application endpoints to test

    • hasActors

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

    • actors

      public final List<Actor> actors()

      List of actors that interact with the system

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

      Returns:
      List of actors that interact with the system

    • 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()

      List of documents providing context for testing

      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:
      List of documents providing context for testing

    • 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()

      List of source code repositories for static analysis

      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:
      List of source code repositories for static analysis

    • hasExcludePaths

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

    • excludePaths

      public final List<Endpoint> excludePaths()

      List of URL paths to exclude from testing

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

      Returns:
      List of URL paths to exclude from testing

    • hasAllowedDomains

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

    • allowedDomains

      public final List<Endpoint> allowedDomains()

      List of allowed domains for network access

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

      Returns:
      List of allowed domains for network access

    • excludeRiskTypes

      public final List<RiskType> excludeRiskTypes()

      A list of risk types excluded from the pentest job

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

      Returns:
      A list of risk types excluded from the pentest job

    • hasExcludeRiskTypes

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

    • excludeRiskTypesAsStrings

      public final List<String> excludeRiskTypesAsStrings()

      A list of risk types excluded from the pentest job

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

      Returns:
      A list of risk types excluded from the pentest job

    • hasSteps

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

    • steps

      public final List<Step> steps()

      List of execution steps for the pentest job

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

      Returns:
      List of execution steps for the pentest job

    • hasExecutionContext

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

    • executionContext

      public final List<ExecutionContext> executionContext()

      A list of execution context messages associated with the pentest job

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

      Returns:
      A list of execution context messages associated with the pentest job

    • serviceRole

      public final String serviceRole()

      Service role ARN for accessing customer resources

      Returns:
      Service role ARN for accessing customer resources

    • logConfig

      public final CloudWatchLog logConfig()

      CloudWatch log group and stream prefix where pentest job logs are stored

      Returns:
      CloudWatch log group and stream prefix where pentest job logs are stored

    • vpcConfig

      public final VpcConfig vpcConfig()

      VPC configuration that the Security Agent accesses

      Returns:
      VPC configuration that the Security Agent accesses

    • networkTrafficConfig

      public final NetworkTrafficConfig networkTrafficConfig()

      Configuration for network traffic filtering

      Returns:
      Configuration for network traffic filtering

    • errorInformation

      public final ErrorInformation errorInformation()

      Error information regarding the pentest job

      Returns:
      Error information regarding the pentest job

    • 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()

      List of integrated code repositories

      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:
      List of integrated code repositories

    • codeRemediationStrategy

      public final CodeRemediationStrategy codeRemediationStrategy()

      Strategy for code remediation on findings

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

      Returns:
      Strategy for code remediation on findings
      See Also:

    • codeRemediationStrategyAsString

      public final String codeRemediationStrategyAsString()

      Strategy for code remediation on findings

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

      Returns:
      Strategy for code remediation on findings
      See Also:

    • createdAt

      public final Instant createdAt()

      Timestamp when the pentest job was created

      Returns:
      Timestamp when the pentest job was created

    • updatedAt

      public final Instant updatedAt()

      Timestamp when the pentest job was last updated

      Returns:
      Timestamp when the pentest job was last updated

    • toBuilder

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

    • builder

      public static PentestJob.Builder builder()

    • serializableBuilderClass

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