Class ListScanJobsRequest

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

  • Method Details

    • byAccountId

      public final 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}$

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

    • byBackupVaultName

      public final 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}$

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

    • byCompleteAfter

      public final Instant byCompleteAfter()

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

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

    • byCompleteBefore

      public final Instant byCompleteBefore()

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

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

    • byMalwareScanner

      public final MalwareScanner byMalwareScanner()

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

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

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

    • byMalwareScannerAsString

      public final String byMalwareScannerAsString()

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

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

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

    • byRecoveryPointArn

      public final String byRecoveryPointArn()

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

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

    • byResourceArn

      public final String byResourceArn()

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

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

    • byResourceType

      public final 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}$

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

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

      See Also:

    • byResourceTypeAsString

      public final String byResourceTypeAsString()

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

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

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

      See Also:

    • byScanResultStatus

      public final ScanResultStatus byScanResultStatus()

      Returns only the scan jobs for the specified scan results:

      • THREATS_FOUND

      • NO_THREATS_FOUND

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

      Returns:
      Returns only the scan jobs for the specified scan results:

      • THREATS_FOUND

      • NO_THREATS_FOUND

      See Also:

    • byScanResultStatusAsString

      public final String byScanResultStatusAsString()

      Returns only the scan jobs for the specified scan results:

      • THREATS_FOUND

      • NO_THREATS_FOUND

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

      Returns:
      Returns only the scan jobs for the specified scan results:

      • THREATS_FOUND

      • NO_THREATS_FOUND

      See Also:

    • byState

      public final ScanState byState()

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

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

      Returns:
      Returns only the scan jobs for the specified scanning job state.
      See Also:

    • byStateAsString

      public final String byStateAsString()

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

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

      Returns:
      Returns only the scan jobs for the specified scanning job state.
      See Also:

    • maxResults

      public final Integer maxResults()

      The maximum number of items to be returned.

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

      Returns:
      The maximum number of items to be returned.

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

    • nextToken

      public final 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.

      Returns:
      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.

    • toBuilder

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

    • builder

      public static ListScanJobsRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.