Class StartScanJobRequest

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.StartScanJobRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartScanJobRequest.Builder,StartScanJobRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartScanJobRequest extends BackupRequest implements ToCopyableBuilder<StartScanJobRequest.Builder,StartScanJobRequest>

  • Method Details

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

    • iamRoleArn

      public final String iamRoleArn()

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

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

    • idempotencyToken

      public final String idempotencyToken()

      A customer-chosen string that you can use to distinguish between otherwise identical calls to StartScanJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

      Returns:
      A customer-chosen string that you can use to distinguish between otherwise identical calls to StartScanJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

    • malwareScanner

      public final MalwareScanner malwareScanner()

      Specifies the malware scanner used during the scan job. Currently only supports GUARDDUTY.

      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:
      Specifies the malware scanner used during the scan job. Currently only supports GUARDDUTY.
      See Also:

    • malwareScannerAsString

      public final String malwareScannerAsString()

      Specifies the malware scanner used during the scan job. Currently only supports GUARDDUTY.

      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:
      Specifies the malware scanner used during the scan job. Currently only supports GUARDDUTY.
      See Also:

    • recoveryPointArn

      public final String recoveryPointArn()

      An Amazon Resource Name (ARN) that uniquely identifies a recovery point. This is your target recovery point for a full scan. If you are running an incremental scan, this will be your a recovery point which has been created after your base recovery point selection.

      Returns:
      An Amazon Resource Name (ARN) that uniquely identifies a recovery point. This is your target recovery point for a full scan. If you are running an incremental scan, this will be your a recovery point which has been created after your base recovery point selection.

    • scanBaseRecoveryPointArn

      public final String scanBaseRecoveryPointArn()

      An ARN that uniquely identifies the base recovery point to be used for incremental scanning.

      Returns:
      An ARN that uniquely identifies the base recovery point to be used for incremental scanning.

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

    • scannerRoleArn

      public final String scannerRoleArn()

      Specified the IAM scanner role ARN.

      Returns:
      Specified the IAM scanner role ARN.

    • toBuilder

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

    • builder

      public static StartScanJobRequest.Builder builder()

    • serializableBuilderClass

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