Interface ListScanJobsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BackupRequest.Builder, Buildable, CopyableBuilder<ListScanJobsRequest.Builder,ListScanJobsRequest>, SdkBuilder<ListScanJobsRequest.Builder,ListScanJobsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListScanJobsRequest
@Mutable @NotThreadSafe public static interface ListScanJobsRequest.Builder extends BackupRequest.Builder, SdkPojo, CopyableBuilder<ListScanJobsRequest.Builder,ListScanJobsRequest>

  • Method Details

    • byAccountId

      ListScanJobsRequest.Builder byAccountId(String byAccountId)

      The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.

      If used from an Amazon Web Services Organizations management account, passing * returns all jobs across the organization.

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

      Parameters:
      byAccountId - The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.

      If used from an Amazon Web Services Organizations management account, passing * returns all jobs across the organization.

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

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

    • byBackupVaultName

      ListScanJobsRequest.Builder byBackupVaultName(String byBackupVaultName)

      Returns only scan jobs that will be stored in the specified backup vault. 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:
      byBackupVaultName - Returns only scan jobs that will be stored in the specified backup vault. 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.

    • byCompleteAfter

      ListScanJobsRequest.Builder byCompleteAfter(Instant byCompleteAfter)

      Returns only scan jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

      Parameters:
      byCompleteAfter - Returns only scan jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • byCompleteBefore

      ListScanJobsRequest.Builder byCompleteBefore(Instant byCompleteBefore)

      Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

      Parameters:
      byCompleteBefore - Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • byMalwareScanner

      ListScanJobsRequest.Builder byMalwareScanner(String byMalwareScanner)

      Returns only the scan jobs for the specified malware scanner. Currently only supports GUARDDUTY.

      Parameters:
      byMalwareScanner - Returns only the scan jobs for the specified malware scanner. Currently only supports GUARDDUTY.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • byMalwareScanner

      ListScanJobsRequest.Builder byMalwareScanner(MalwareScanner byMalwareScanner)

      Returns only the scan jobs for the specified malware scanner. Currently only supports GUARDDUTY.

      Parameters:
      byMalwareScanner - Returns only the scan jobs for the specified malware scanner. Currently only supports GUARDDUTY.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • byRecoveryPointArn

      ListScanJobsRequest.Builder byRecoveryPointArn(String byRecoveryPointArn)

      Returns only the scan jobs that are ran against the specified recovery point.

      Parameters:
      byRecoveryPointArn - Returns only the scan jobs that are ran against the specified recovery point.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • byResourceArn

      ListScanJobsRequest.Builder byResourceArn(String byResourceArn)

      Returns only scan jobs that match the specified resource Amazon Resource Name (ARN).

      Parameters:
      byResourceArn - Returns only scan jobs that match the specified resource Amazon Resource Name (ARN).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • byResourceType

      ListScanJobsRequest.Builder byResourceType(String byResourceType)

      Returns restore testing selections by the specified restore testing plan name.

      • EBSfor Amazon Elastic Block Store

      • EC2for Amazon Elastic Compute Cloud

      • S3for Amazon Simple Storage Service (Amazon S3)

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

      Parameters:
      byResourceType - Returns restore testing selections by the specified restore testing plan name.

      • EBSfor Amazon Elastic Block Store

      • EC2for Amazon Elastic Compute Cloud

      • S3for Amazon Simple Storage Service (Amazon S3)

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

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

    • byResourceType

      ListScanJobsRequest.Builder byResourceType(ScanResourceType byResourceType)

      Returns restore testing selections by the specified restore testing plan name.

      • EBSfor Amazon Elastic Block Store

      • EC2for Amazon Elastic Compute Cloud

      • S3for Amazon Simple Storage Service (Amazon S3)

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

      Parameters:
      byResourceType - Returns restore testing selections by the specified restore testing plan name.

      • EBSfor Amazon Elastic Block Store

      • EC2for Amazon Elastic Compute Cloud

      • S3for Amazon Simple Storage Service (Amazon S3)

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

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

    • byScanResultStatus

      ListScanJobsRequest.Builder byScanResultStatus(String byScanResultStatus)

      Returns only the scan jobs for the specified scan results:

      • THREATS_FOUND

      • NO_THREATS_FOUND

      Parameters:
      byScanResultStatus - Returns only the scan jobs for the specified scan results:

      • THREATS_FOUND

      • NO_THREATS_FOUND

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

    • byScanResultStatus

      ListScanJobsRequest.Builder byScanResultStatus(ScanResultStatus byScanResultStatus)

      Returns only the scan jobs for the specified scan results:

      • THREATS_FOUND

      • NO_THREATS_FOUND

      Parameters:
      byScanResultStatus - Returns only the scan jobs for the specified scan results:

      • THREATS_FOUND

      • NO_THREATS_FOUND

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

    • byState

      ListScanJobsRequest.Builder byState(String byState)

      Returns only the scan jobs for the specified scanning job state.

      Parameters:
      byState - Returns only the scan jobs for the specified scanning job state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • byState

      ListScanJobsRequest.Builder byState(ScanState byState)

      Returns only the scan jobs for the specified scanning job state.

      Parameters:
      byState - Returns only the scan jobs for the specified scanning job state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxResults

      ListScanJobsRequest.Builder maxResults(Integer maxResults)

      The maximum number of items to be returned.

      Valid Range: Minimum value of 1. Maximum value of 1000.

      Parameters:
      maxResults - The maximum number of items to be returned.

      Valid Range: Minimum value of 1. Maximum value of 1000.

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

    • nextToken

      ListScanJobsRequest.Builder nextToken(String nextToken)

      The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

      Parameters:
      nextToken - The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ListScanJobsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListScanJobsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.