Interface DescribeScanJobResponse.Builder

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

  • Method Details

    • accountId

      DescribeScanJobResponse.Builder accountId(String accountId)

      Returns the account ID that owns the scan job.

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

      Parameters:
      accountId - Returns the account ID that owns the scan job.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • backupVaultArn

      DescribeScanJobResponse.Builder backupVaultArn(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • backupVaultName

      DescribeScanJobResponse.Builder backupVaultName(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}$

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • completionDate

      DescribeScanJobResponse.Builder completionDate(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • createdBy

      DescribeScanJobResponse.Builder createdBy(ScanJobCreator createdBy)
      Sets the value of the CreatedBy property for this object.
      Parameters:
      createdBy - The new value for the CreatedBy property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdBy

      default DescribeScanJobResponse.Builder createdBy(Consumer<ScanJobCreator.Builder> createdBy)
      Sets the value of the CreatedBy property for this object. This is a convenience method that creates an instance of the ScanJobCreator.Builder avoiding the need to create one manually via ScanJobCreator.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to createdBy(ScanJobCreator).

      Parameters:
      createdBy - a consumer that will call methods on ScanJobCreator.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • creationDate

      DescribeScanJobResponse.Builder creationDate(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • iamRoleArn

      DescribeScanJobResponse.Builder iamRoleArn(String iamRoleArn)

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

      Parameters:
      iamRoleArn - An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:iam::123456789012:role/S3Access.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • malwareScanner

      DescribeScanJobResponse.Builder malwareScanner(String malwareScanner)

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

      Parameters:
      malwareScanner - The scanning engine used for the corresponding scan job. Currently only GUARDUTY is supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • malwareScanner

      DescribeScanJobResponse.Builder malwareScanner(MalwareScanner malwareScanner)

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

      Parameters:
      malwareScanner - The scanning engine used for the corresponding scan job. Currently only GUARDUTY is supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • recoveryPointArn

      DescribeScanJobResponse.Builder recoveryPointArn(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • resourceArn

      DescribeScanJobResponse.Builder resourceArn(String resourceArn)

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

      Parameters:
      resourceArn - An ARN that uniquely identifies the source resource of the corresponding recovery point ARN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceName

      DescribeScanJobResponse.Builder resourceName(String resourceName)

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

      Parameters:
      resourceName - The non-unique name of the resource that belongs to the specified backup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceType

      DescribeScanJobResponse.Builder resourceType(String 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}$

      Parameters:
      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}$

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resourceType

      DescribeScanJobResponse.Builder resourceType(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}$

      Parameters:
      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}$

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scanBaseRecoveryPointArn

      DescribeScanJobResponse.Builder scanBaseRecoveryPointArn(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • scanId

      DescribeScanJobResponse.Builder scanId(String scanId)

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

      Parameters:
      scanId - The scan ID generated by Amazon GuardDuty for the corresponding Scan Job ID request from Backup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scanJobId

      DescribeScanJobResponse.Builder scanJobId(String scanJobId)

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

      Parameters:
      scanJobId - The scan job ID that uniquely identified the request to Backup.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scanMode

      DescribeScanJobResponse.Builder scanMode(String scanMode)

      Specifies the scan type used for the scan job.

      Parameters:
      scanMode - Specifies the scan type used for the scan job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scanMode

      DescribeScanJobResponse.Builder scanMode(ScanMode scanMode)

      Specifies the scan type used for the scan job.

      Parameters:
      scanMode - Specifies the scan type used for the scan job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scanResult

      DescribeScanJobResponse.Builder scanResult(ScanResultInfo scanResult)

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

      Parameters:
      scanResult - Contains the ScanResultsStatus for the scanning job and returns THREATS_FOUND or NO_THREATS_FOUND for completed jobs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scanResult

      default DescribeScanJobResponse.Builder scanResult(Consumer<ScanResultInfo.Builder> scanResult)

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

      This is a convenience method that creates an instance of the ScanResultInfo.Builder avoiding the need to create one manually via ScanResultInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scanResult(ScanResultInfo).

      Parameters:
      scanResult - a consumer that will call methods on ScanResultInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scannerRoleArn

      DescribeScanJobResponse.Builder scannerRoleArn(String scannerRoleArn)

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

      Parameters:
      scannerRoleArn - Specifies the scanner IAM role ARN used to for the scan job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      DescribeScanJobResponse.Builder state(String state)

      The current state of a scan job.

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

    • state

      DescribeScanJobResponse.Builder state(ScanState state)

      The current state of a scan job.

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

    • statusMessage

      DescribeScanJobResponse.Builder statusMessage(String statusMessage)

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

      Parameters:
      statusMessage - A detailed message explaining the status of the job to back up a resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.