Class RestoreTestingRecoveryPointSelection

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

RecoveryPointSelection has five parameters (three required and two optional). The values you specify determine which recovery point is included in the restore test. You must indicate with Algorithm if you want the latest recovery point within your SelectionWindowDays or if you want a random recovery point, and you must indicate through IncludeVaults from which vaults the recovery points can be chosen.

Algorithm (required) Valid values: "LATEST_WITHIN_WINDOW" or " RANDOM_WITHIN_WINDOW".

Recovery point types (required) Valid values: "SNAPSHOT" and/or " CONTINUOUS". Include SNAPSHOT to restore only snapshot recovery points; include CONTINUOUS to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for Algorithm.

IncludeVaults (required). You must include one or more backup vaults. Use the wildcard ["*"] or specific ARNs.

SelectionWindowDays (optional) Value must be an integer (in days) from 1 to 365. If not included, the value defaults to 30.

ExcludeVaults (optional). You can choose to input one or more specific backup vault ARNs to exclude those vaults' contents from restore eligibility. Or, you can include a list of selectors. If this parameter and its value are not included, it defaults to empty list.

See Also:

  • Method Details

    • algorithm

      public final RestoreTestingRecoveryPointSelectionAlgorithm algorithm()

      Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW"

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

      Returns:
      Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW"
      See Also:

    • algorithmAsString

      public final String algorithmAsString()

      Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW"

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

      Returns:
      Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW"
      See Also:

    • hasExcludeVaults

      public final boolean hasExcludeVaults()
      For responses, this returns true if the service returned a value for the ExcludeVaults 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.

    • excludeVaults

      public final List<String> excludeVaults()

      Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.

      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 hasExcludeVaults() method.

      Returns:
      Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.

    • hasIncludeVaults

      public final boolean hasIncludeVaults()
      For responses, this returns true if the service returned a value for the IncludeVaults 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.

    • includeVaults

      public final List<String> includeVaults()

      Accepted values include wildcard ["*"] or by specific ARNs or ARN wilcard replacement ["arn:aws:backup:us-west-2:123456789012:backup-vault:asdf", ...] ["arn:aws:backup:*:*:backup-vault:asdf-*", ...]

      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 hasIncludeVaults() method.

      Returns:
      Accepted values include wildcard ["*"] or by specific ARNs or ARN wilcard replacement ["arn:aws:backup:us-west-2:123456789012:backup-vault:asdf", ...] ["arn:aws:backup:*:*:backup-vault:asdf-*", ...]

    • recoveryPointTypes

      public final List<RestoreTestingRecoveryPointType> recoveryPointTypes()

      These are the types of recovery points.

      Include SNAPSHOT to restore only snapshot recovery points; include CONTINUOUS to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for Algorithm.

      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 hasRecoveryPointTypes() method.

      Returns:
      These are the types of recovery points.

      Include SNAPSHOT to restore only snapshot recovery points; include CONTINUOUS to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for Algorithm.

    • hasRecoveryPointTypes

      public final boolean hasRecoveryPointTypes()
      For responses, this returns true if the service returned a value for the RecoveryPointTypes 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.

    • recoveryPointTypesAsStrings

      public final List<String> recoveryPointTypesAsStrings()

      These are the types of recovery points.

      Include SNAPSHOT to restore only snapshot recovery points; include CONTINUOUS to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for Algorithm.

      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 hasRecoveryPointTypes() method.

      Returns:
      These are the types of recovery points.

      Include SNAPSHOT to restore only snapshot recovery points; include CONTINUOUS to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for Algorithm.

    • selectionWindowDays

      public final Integer selectionWindowDays()

      Accepted values are integers from 1 to 365.

      Returns:
      Accepted values are integers from 1 to 365.

    • toBuilder

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

    • builder

      public static RestoreTestingRecoveryPointSelection.Builder builder()

    • serializableBuilderClass

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