Class Backup

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

A backup of an Amazon FSx for Windows File Server, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system.

See Also:

  • Method Details

    • backupId

      public final String backupId()

      The ID of the backup.

      Returns:
      The ID of the backup.

    • lifecycle

      public final BackupLifecycle lifecycle()

      The lifecycle status of the backup.

      • AVAILABLE - The backup is fully available.

      • PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup.

      • CREATING - Amazon FSx is creating the backup.

      • TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to Amazon S3.

      • COPYING - Amazon FSx is copying the backup.

      • DELETED - Amazon FSx deleted the backup and it's no longer available.

      • FAILED - Amazon FSx couldn't finish the backup.

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

      Returns:
      The lifecycle status of the backup.

      • AVAILABLE - The backup is fully available.

      • PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup.

      • CREATING - Amazon FSx is creating the backup.

      • TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to Amazon S3.

      • COPYING - Amazon FSx is copying the backup.

      • DELETED - Amazon FSx deleted the backup and it's no longer available.

      • FAILED - Amazon FSx couldn't finish the backup.

      See Also:

    • lifecycleAsString

      public final String lifecycleAsString()

      The lifecycle status of the backup.

      • AVAILABLE - The backup is fully available.

      • PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup.

      • CREATING - Amazon FSx is creating the backup.

      • TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to Amazon S3.

      • COPYING - Amazon FSx is copying the backup.

      • DELETED - Amazon FSx deleted the backup and it's no longer available.

      • FAILED - Amazon FSx couldn't finish the backup.

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

      Returns:
      The lifecycle status of the backup.

      • AVAILABLE - The backup is fully available.

      • PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx hasn't started creating the backup.

      • CREATING - Amazon FSx is creating the backup.

      • TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to Amazon S3.

      • COPYING - Amazon FSx is copying the backup.

      • DELETED - Amazon FSx deleted the backup and it's no longer available.

      • FAILED - Amazon FSx couldn't finish the backup.

      See Also:

    • failureDetails

      public final BackupFailureDetails failureDetails()

      Details explaining any failures that occurred when creating a backup.

      Returns:
      Details explaining any failures that occurred when creating a backup.

    • type

      public final BackupType type()

      The type of the file-system backup.

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

      Returns:
      The type of the file-system backup.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the file-system backup.

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

      Returns:
      The type of the file-system backup.
      See Also:

    • progressPercent

      public final Integer progressPercent()
      Returns the value of the ProgressPercent property for this object.
      Returns:
      The value of the ProgressPercent property for this object.

    • creationTime

      public final Instant creationTime()

      The time when a particular backup was created.

      Returns:
      The time when a particular backup was created.

    • kmsKeyId

      public final String kmsKeyId()

      The ID of the Key Management Service (KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.

      Returns:
      The ID of the Key Management Service (KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.

    • resourceARN

      public final String resourceARN()

      The Amazon Resource Name (ARN) for the backup resource.

      Returns:
      The Amazon Resource Name (ARN) for the backup resource.

    • hasTags

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

    • tags

      public final List<Tag> tags()

      The tags associated with a particular file system.

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

      Returns:
      The tags associated with a particular file system.

    • fileSystem

      public final FileSystem fileSystem()

      The metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.

      Returns:
      The metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.

    • directoryInformation

      public final ActiveDirectoryBackupAttributes directoryInformation()

      The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.

      Returns:
      The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.

    • ownerId

      public final String ownerId()
      Returns the value of the OwnerId property for this object.
      Returns:
      The value of the OwnerId property for this object.

    • sourceBackupId

      public final String sourceBackupId()
      Returns the value of the SourceBackupId property for this object.
      Returns:
      The value of the SourceBackupId property for this object.

    • sourceBackupRegion

      public final String sourceBackupRegion()

      The source Region of the backup. Specifies the Region from where this backup is copied.

      Returns:
      The source Region of the backup. Specifies the Region from where this backup is copied.

    • resourceType

      public final ResourceType resourceType()

      Specifies the resource type that's backed up.

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

      Returns:
      Specifies the resource type that's backed up.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      Specifies the resource type that's backed up.

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

      Returns:
      Specifies the resource type that's backed up.
      See Also:

    • volume

      public final Volume volume()
      Returns the value of the Volume property for this object.
      Returns:
      The value of the Volume property for this object.

    • sizeInBytes

      public final Long sizeInBytes()

      The size of the backup in bytes. This represents the amount of data that the file system would contain if you restore this backup.

      Returns:
      The size of the backup in bytes. This represents the amount of data that the file system would contain if you restore this backup.

    • toBuilder

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

    • builder

      public static Backup.Builder builder()

    • serializableBuilderClass

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