Class DescribeScanJobResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.backup.model.BackupResponse
software.amazon.awssdk.services.backup.model.DescribeScanJobResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeScanJobResponse.Builder,DescribeScanJobResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeScanJobResponse extends BackupResponse implements ToCopyableBuilder<DescribeScanJobResponse.Builder,DescribeScanJobResponse>

  • Method Details

    • accountId

      public final String accountId()

      Returns the account ID that owns the scan job.

      Pattern: ^[0-9]{12}$

      Returns:
      Returns the account ID that owns the scan job.

      Pattern: ^[0-9]{12}$

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

      Pattern: ^[a-zA-Z0-9\-\_\.]{2,50}$

      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.

      Pattern: ^[a-zA-Z0-9\-\_\.]{2,50}$

    • completionDate

      public final Instant completionDate()

      The date and time that a backup index finished creation, 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 backup index finished creation, 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()
      Returns the value of the CreatedBy property for this object.
      Returns:
      The value of the CreatedBy property for this object.

    • creationDate

      public final Instant creationDate()

      The date and time that a backup index finished creation, 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 backup index finished creation, 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()

      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:iam::123456789012:role/S3Access.

      Returns:
      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:iam::123456789012:role/S3Access.

    • malwareScanner

      public final MalwareScanner malwareScanner()

      The scanning engine used for the corresponding scan job. Currently only GUARDUTY 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 corresponding scan job. Currently only GUARDUTY is supported.
      See Also:

    • malwareScannerAsString

      public final String malwareScannerAsString()

      The scanning engine used for the corresponding scan job. Currently only GUARDUTY 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 corresponding scan job. Currently only GUARDUTY is supported.
      See Also:

    • recoveryPointArn

      public final String recoveryPointArn()

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

      Returns:
      An ARN that uniquely identifies the target recovery point for scanning.; 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 corresponding recovery point ARN.

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

    • 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 to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume.

      Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

      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 to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume.

      Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of Amazon Web Services Resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume.

      Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

      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 to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume.

      Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

      See Also:

    • scanBaseRecoveryPointArn

      public final String scanBaseRecoveryPointArn()

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

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

    • scanId

      public final String scanId()

      The scan ID generated by Amazon GuardDuty for the corresponding Scan Job ID request from Backup.

      Returns:
      The scan ID generated by Amazon GuardDuty for the corresponding Scan Job ID request from Backup.

    • scanJobId

      public final String scanJobId()

      The scan job ID that uniquely identified the request to Backup.

      Returns:
      The scan job ID that uniquely identified the request to Backup.

    • scanMode

      public final ScanMode scanMode()

      Specifies the scan type used for the scan job.

      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 used for the scan job.
      See Also:

    • scanModeAsString

      public final String scanModeAsString()

      Specifies the scan type used for the scan job.

      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 used for the scan job.
      See Also:

    • scanResult

      public final ScanResultInfo scanResult()

      Contains the ScanResultsStatus for the scanning job and returns THREATS_FOUND or NO_THREATS_FOUND for completed jobs.

      Returns:
      Contains the ScanResultsStatus for the scanning job and returns THREATS_FOUND or NO_THREATS_FOUND for completed jobs.

    • scannerRoleArn

      public final String scannerRoleArn()

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

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

    • state

      public final ScanState state()

      The current state of a scan job.

      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 a scan job.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of a scan job.

      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 a scan job.
      See Also:

    • statusMessage

      public final String statusMessage()

      A detailed message explaining the status of the job to back up a resource.

      Returns:
      A detailed message explaining the status of the job to back up a resource.

    • toBuilder

      public DescribeScanJobResponse.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<DescribeScanJobResponse.Builder,DescribeScanJobResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeScanJobResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeScanJobResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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