Class ScanJob

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

Contains metadata about a scan job, including information about the scanning process, results, and associated resources.

See Also:

  • Method Details

    • accountId

      public final String accountId()

      The account ID that owns the scan job.

      Returns:
      The account ID that owns the scan job.

    • backupVaultArn

      public final String backupVaultArn()

      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

      Returns:
      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

    • backupVaultName

      public final String backupVaultName()

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.

      Returns:
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.

    • completionDate

      public final Instant completionDate()

      The date and time that a scan job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      Returns:
      The date and time that a scan job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • createdBy

      public final ScanJobCreator createdBy()

      Contains identifying information about the creation of a scan job.

      Returns:
      Contains identifying information about the creation of a scan job.

    • creationDate

      public final Instant creationDate()

      The date and time that a scan job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      Returns:
      The date and time that a scan job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • iamRoleArn

      public final String iamRoleArn()

      Specifies the IAM role ARN used to create the scan job; for example, arn:aws:iam::123456789012:role/S3Access.

      Returns:
      Specifies the IAM role ARN used to create the scan job; for example, arn:aws:iam::123456789012:role/S3Access.

    • malwareScanner

      public final MalwareScanner malwareScanner()

      The scanning engine used for the scan job. Currently only GUARDDUTY is supported.

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

      Returns:
      The scanning engine used for the scan job. Currently only GUARDDUTY is supported.
      See Also:

    • malwareScannerAsString

      public final String malwareScannerAsString()

      The scanning engine used for the scan job. Currently only GUARDDUTY is supported.

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

      Returns:
      The scanning engine used for the scan job. Currently only GUARDDUTY is supported.
      See Also:

    • recoveryPointArn

      public final String recoveryPointArn()

      An ARN that uniquely identifies the recovery point being scanned; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

      Returns:
      An ARN that uniquely identifies the recovery point being scanned; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

    • resourceArn

      public final String resourceArn()

      An ARN that uniquely identifies the source resource of the recovery point being scanned.

      Returns:
      An ARN that uniquely identifies the source resource of the recovery point being scanned.

    • resourceName

      public final String resourceName()

      The non-unique name of the resource that belongs to the specified backup.

      Returns:
      The non-unique name of the resource that belongs to the specified backup.

    • resourceType

      public final ScanResourceType resourceType()

      The type of Amazon Web Services resource being scanned; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

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

      Returns:
      The type of Amazon Web Services resource being scanned; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of Amazon Web Services resource being scanned; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

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

      Returns:
      The type of Amazon Web Services resource being scanned; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
      See Also:

    • scanBaseRecoveryPointArn

      public final String scanBaseRecoveryPointArn()

      An ARN that uniquely identifies the base recovery point for scanning. This field is populated when an incremental scan job has taken place.

      Returns:
      An ARN that uniquely identifies the base recovery point for scanning. This field is populated when an incremental scan job has taken place.

    • scanId

      public final String scanId()

      The scan ID generated by the malware scanner for the corresponding scan job.

      Returns:
      The scan ID generated by the malware scanner for the corresponding scan job.

    • scanJobId

      public final String scanJobId()

      The unique identifier that identifies the scan job request to Backup.

      Returns:
      The unique identifier that identifies the scan job request to Backup.

    • scanMode

      public final ScanMode scanMode()

      Specifies the scan type use for the scan job.

      Includes:

      FULL_SCAN will scan the entire data lineage within the backup.

      INCREMENTAL_SCAN will scan the data difference between the target recovery point and base recovery point ARN.

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

      Returns:
      Specifies the scan type use for the scan job.

      Includes:

      FULL_SCAN will scan the entire data lineage within the backup.

      INCREMENTAL_SCAN will scan the data difference between the target recovery point and base recovery point ARN.

      See Also:

    • scanModeAsString

      public final String scanModeAsString()

      Specifies the scan type use for the scan job.

      Includes:

      FULL_SCAN will scan the entire data lineage within the backup.

      INCREMENTAL_SCAN will scan the data difference between the target recovery point and base recovery point ARN.

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

      Returns:
      Specifies the scan type use for the scan job.

      Includes:

      FULL_SCAN will scan the entire data lineage within the backup.

      INCREMENTAL_SCAN will scan the data difference between the target recovery point and base recovery point ARN.

      See Also:

    • scanResult

      public final ScanResultInfo scanResult()

      Contains the scan results information, including the status of threats found during scanning.

      Returns:
      Contains the scan results information, including the status of threats found during scanning.

    • scannerRoleArn

      public final String scannerRoleArn()

      Specifies the scanner IAM role ARN used for the scan job.

      Returns:
      Specifies the scanner IAM role ARN used for the scan job.

    • state

      public final ScanState state()

      The current state of the scan job.

      Valid values: CREATED | RUNNING | COMPLETED | COMPLETED_WITH_ISSUES | FAILED | CANCELED.

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

      Returns:
      The current state of the scan job.

      Valid values: CREATED | RUNNING | COMPLETED | COMPLETED_WITH_ISSUES | FAILED | CANCELED.

      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the scan job.

      Valid values: CREATED | RUNNING | COMPLETED | COMPLETED_WITH_ISSUES | FAILED | CANCELED.

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

      Returns:
      The current state of the scan job.

      Valid values: CREATED | RUNNING | COMPLETED | COMPLETED_WITH_ISSUES | FAILED | CANCELED.

      See Also:

    • statusMessage

      public final String statusMessage()

      A detailed message explaining the status of the scan job.

      Returns:
      A detailed message explaining the status of the scan job.

    • toBuilder

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

    • builder

      public static ScanJob.Builder builder()

    • serializableBuilderClass

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