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

Class CreateLogicallyAirGappedBackupVaultRequest

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

  • Method Details

    • backupVaultName

      public final String backupVaultName()

      This is the name of the vault that is being created.

      Returns:
      This is the name of the vault that is being created.

    • hasBackupVaultTags

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

    • backupVaultTags

      public final Map<String,String> backupVaultTags()

      These are the tags that will be included in the newly-created vault.

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

      Returns:
      These are the tags that will be included in the newly-created vault.

    • creatorRequestId

      public final String creatorRequestId()

      This is the ID of the creation request.

      This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

      Returns:
      This is the ID of the creation request.

      This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

    • minRetentionDays

      public final Long minRetentionDays()

      This setting specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, no minimum retention period is enforced.

      If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If a job retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault.

      Returns:
      This setting specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, no minimum retention period is enforced.

      If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If a job retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault.

    • maxRetentionDays

      public final Long maxRetentionDays()

      This is the setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Backup does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).

      If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault.

      Returns:
      This is the setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Backup does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).

      If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault.

    • toBuilder

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

    • builder

      public static CreateLogicallyAirGappedBackupVaultRequest.Builder builder()

    • serializableBuilderClass

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