Class Backup
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
backupId()
The ID of the backup.static Backup.Builder
builder()
final Instant
The time when a particular backup was created.The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final BackupFailureDetails
Details explaining any failures that occurred when creating a backup.final FileSystem
The metadata of the file system associated with the backup.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.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.final BackupLifecycle
The lifecycle status of the backup.final String
The lifecycle status of the backup.final String
ownerId()
Returns the value of the OwnerId property for this object.final Integer
Returns the value of the ProgressPercent property for this object.final String
The Amazon Resource Name (ARN) for the backup resource.final ResourceType
Specifies the resource type that's backed up.final String
Specifies the resource type that's backed up.static Class
<? extends Backup.Builder> final String
Returns the value of the SourceBackupId property for this object.final String
The source Region of the backup.tags()
The tags associated with a particular file system.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final BackupType
type()
The type of the file-system backup.final String
The type of the file-system backup.final Volume
volume()
Returns the value of the Volume property for this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
backupId
The ID of the backup.
- Returns:
- The ID of the backup.
-
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 returnBackupLifecycle.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlifecycleAsString()
.- 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
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 returnBackupLifecycle.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlifecycleAsString()
.- 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
Details explaining any failures that occurred when creating a backup.
- Returns:
- Details explaining any failures that occurred when creating a backup.
-
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 returnBackupType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the file-system backup.
- See Also:
-
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 returnBackupType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the file-system backup.
- See Also:
-
progressPercent
Returns the value of the ProgressPercent property for this object.- Returns:
- The value of the ProgressPercent property for this object.
-
creationTime
The time when a particular backup was created.
- Returns:
- The time when a particular backup was created.
-
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
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 theisEmpty()
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
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
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
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
Returns the value of the OwnerId property for this object.- Returns:
- The value of the OwnerId property for this object.
-
sourceBackupId
Returns the value of the SourceBackupId property for this object.- Returns:
- The value of the SourceBackupId property for this object.
-
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
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 returnResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- Specifies the resource type that's backed up.
- See Also:
-
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 returnResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- Specifies the resource type that's backed up.
- See Also:
-
volume
Returns the value of the Volume property for this object.- Returns:
- The value of the Volume property for this object.
-
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 interfaceToCopyableBuilder<Backup.Builder,
Backup> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-