Backup (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.fsx.model.Backup

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Backup.Builder,Backup>
```
@Generated(value="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 file system. You can create a new file system from a backup to protect against data loss.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Backup.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Backup.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`backupId()` The ID of the backup.
`static Backup.Builder`	`builder()`
`Instant`	`creationTime()` The time when a particular backup was created.
`boolean`	`equals(Object obj)`
`BackupFailureDetails`	`failureDetails()` Details explaining any failures that occur when creating a backup.
`FileSystem`	`fileSystem()` Metadata of the file system associated with the backup.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`kmsKeyId()` The ID of the AWS Key Management Service (AWS KMS) key used to encrypt this backup's data.
`BackupLifecycle`	`lifecycle()` The lifecycle status of the backup.
`String`	`lifecycleAsString()` The lifecycle status of the backup.
`Integer`	`progressPercent()` Returns the value of the ProgressPercent property for this object.
`String`	`resourceARN()` The Amazon Resource Name (ARN) for the backup resource.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Backup.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` Tags associated with a particular file system.
`Backup.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`BackupType`	`type()` The type of the backup.
`String`	`typeAsString()` The type of the backup.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - backupId
```
public String backupId()
```
    The ID of the backup.
    
    Returns:
    
    The ID of the backup.
  - lifecycle
```
public BackupLifecycle lifecycle()
```
    The lifecycle status of 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.
    
    See Also:
    
    BackupLifecycle
  - lifecycleAsString
```
public String lifecycleAsString()
```
    The lifecycle status of 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.
    
    See Also:
    
    BackupLifecycle
  - failureDetails
```
public BackupFailureDetails failureDetails()
```
    Details explaining any failures that occur when creating a backup.
    
    Returns:
    
    Details explaining any failures that occur when creating a backup.
  - type
```
public BackupType type()
```
    The type of the 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 backup.
    
    See Also:
    
    BackupType
  - typeAsString
```
public String typeAsString()
```
    The type of the 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 backup.
    
    See Also:
    
    BackupType
  - progressPercent
```
public Integer progressPercent()
```
    Returns the value of the ProgressPercent property for this object.
    
    Returns:
    
    The value of the ProgressPercent property for this object.
  - creationTime
```
public Instant creationTime()
```
    The time when a particular backup was created.
    
    Returns:
    
    The time when a particular backup was created.
  - kmsKeyId
```
public String kmsKeyId()
```
    The ID of the AWS Key Management Service (AWS KMS) key used to encrypt this backup's data.
    
    Returns:
    
    The ID of the AWS Key Management Service (AWS KMS) key used to encrypt this backup's data.
  - resourceARN
```
public String resourceARN()
```
    The Amazon Resource Name (ARN) for the backup resource.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the backup resource.
  - tags
```
public List<Tag> tags()
```
    Tags associated with a particular file system.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Tags associated with a particular file system.
  - fileSystem
```
public FileSystem fileSystem()
```
    Metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.
    
    Returns:
    
    Metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.
  - 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public 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.

Class Backup

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

backupId

lifecycle

lifecycleAsString

failureDetails

type

typeAsString

progressPercent

creationTime

kmsKeyId

resourceARN

tags

fileSystem

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields