Package software.amazon.awssdk.services.backup.model

Class AdvancedBackupSetting

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

A list of backup options for each resource type.

See Also:

  • Method Details

    • resourceType

      public final String resourceType()

      Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.

      Valid values: EC2.

      Returns:
      Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.

      Valid values: EC2.

    • hasBackupOptions

      public final boolean hasBackupOptions()
      For responses, this returns true if the service returned a value for the BackupOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • backupOptions

      public final Map<String,String> backupOptions()

      Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

      Valid values:

      Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.

      Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

      If you specify an invalid option, you get an InvalidParameterValueException exception.

      For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBackupOptions() method.

      Returns:
      Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

      Valid values:

      Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.

      Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

      If you specify an invalid option, you get an InvalidParameterValueException exception.

      For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.

    • toBuilder

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

    • builder

      public static AdvancedBackupSetting.Builder builder()

    • serializableBuilderClass

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