Class ScanAction

java.lang.Object
software.amazon.awssdk.services.backup.model.ScanAction
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ScanAction.Builder,ScanAction>
@Generated("software.amazon.awssdk:codegen") public final class ScanAction extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ScanAction.Builder,ScanAction>

Defines a scanning action that specifies the malware scanner and scan mode to use.

See Also:

  • Method Details

    • malwareScanner

      public final MalwareScanner malwareScanner()

      The malware scanner to use for the scan action. Currently only GUARDDUTY 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 malware scanner to use for the scan action. Currently only GUARDDUTY is supported.
      See Also:

    • malwareScannerAsString

      public final String malwareScannerAsString()

      The malware scanner to use for the scan action. Currently only GUARDDUTY 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 malware scanner to use for the scan action. Currently only GUARDDUTY is supported.
      See Also:

    • scanMode

      public final ScanMode scanMode()

      The scanning mode to use for the scan action.

      Valid values: FULL_SCAN | INCREMENTAL_SCAN.

      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:
      The scanning mode to use for the scan action.

      Valid values: FULL_SCAN | INCREMENTAL_SCAN.

      See Also:

    • scanModeAsString

      public final String scanModeAsString()

      The scanning mode to use for the scan action.

      Valid values: FULL_SCAN | INCREMENTAL_SCAN.

      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:
      The scanning mode to use for the scan action.

      Valid values: FULL_SCAN | INCREMENTAL_SCAN.

      See Also:

    • toBuilder

      public ScanAction.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<ScanAction.Builder,ScanAction>
      Returns:
      a builder for type T

    • builder

      public static ScanAction.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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