Backup (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.fsx.model.Backup

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Backup
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Backup()

Constructors
Constructor and Description
`Backup()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Backup`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBackupId()` The ID of the backup.
`Date`	`getCreationTime()` The time when a particular backup was created.
`ActiveDirectoryBackupAttributes`	`getDirectoryInformation()` The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.
`BackupFailureDetails`	`getFailureDetails()` Details explaining any failures that occurred when creating a backup.
`FileSystem`	`getFileSystem()` The metadata of the file system associated with the backup.
`String`	`getKmsKeyId()` The ID of the Key Management Service (KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
`String`	`getLifecycle()` The lifecycle status of the backup.
`String`	`getOwnerId()`
`Integer`	`getProgressPercent()`
`String`	`getResourceARN()` The Amazon Resource Name (ARN) for the backup resource.
`String`	`getResourceType()` Specifies the resource type that's backed up.
`String`	`getSourceBackupId()`
`String`	`getSourceBackupRegion()` The source Region of the backup.
`List<Tag>`	`getTags()` The tags associated with a particular file system.
`String`	`getType()` The type of the file-system backup.
`Volume`	`getVolume()`
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBackupId(String backupId)` The ID of the backup.
`void`	`setCreationTime(Date creationTime)` The time when a particular backup was created.
`void`	`setDirectoryInformation(ActiveDirectoryBackupAttributes directoryInformation)` The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.
`void`	`setFailureDetails(BackupFailureDetails failureDetails)` Details explaining any failures that occurred when creating a backup.
`void`	`setFileSystem(FileSystem fileSystem)` The metadata of the file system associated with the backup.
`void`	`setKmsKeyId(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.
`void`	`setLifecycle(String lifecycle)` The lifecycle status of the backup.
`void`	`setOwnerId(String ownerId)`
`void`	`setProgressPercent(Integer progressPercent)`
`void`	`setResourceARN(String resourceARN)` The Amazon Resource Name (ARN) for the backup resource.
`void`	`setResourceType(String resourceType)` Specifies the resource type that's backed up.
`void`	`setSourceBackupId(String sourceBackupId)`
`void`	`setSourceBackupRegion(String sourceBackupRegion)` The source Region of the backup.
`void`	`setTags(Collection<Tag> tags)` The tags associated with a particular file system.
`void`	`setType(String type)` The type of the file-system backup.
`void`	`setVolume(Volume volume)`
`String`	`toString()` Returns a string representation of this object.
`Backup`	`withBackupId(String backupId)` The ID of the backup.
`Backup`	`withCreationTime(Date creationTime)` The time when a particular backup was created.
`Backup`	`withDirectoryInformation(ActiveDirectoryBackupAttributes directoryInformation)` The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.
`Backup`	`withFailureDetails(BackupFailureDetails failureDetails)` Details explaining any failures that occurred when creating a backup.
`Backup`	`withFileSystem(FileSystem fileSystem)` The metadata of the file system associated with the backup.
`Backup`	`withKmsKeyId(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.
`Backup`	`withLifecycle(BackupLifecycle lifecycle)` The lifecycle status of the backup.
`Backup`	`withLifecycle(String lifecycle)` The lifecycle status of the backup.
`Backup`	`withOwnerId(String ownerId)`
`Backup`	`withProgressPercent(Integer progressPercent)`
`Backup`	`withResourceARN(String resourceARN)` The Amazon Resource Name (ARN) for the backup resource.
`Backup`	`withResourceType(ResourceType resourceType)` Specifies the resource type that's backed up.
`Backup`	`withResourceType(String resourceType)` Specifies the resource type that's backed up.
`Backup`	`withSourceBackupId(String sourceBackupId)`
`Backup`	`withSourceBackupRegion(String sourceBackupRegion)` The source Region of the backup.
`Backup`	`withTags(Collection<Tag> tags)` The tags associated with a particular file system.
`Backup`	`withTags(Tag... tags)` The tags associated with a particular file system.
`Backup`	`withType(BackupType type)` The type of the file-system backup.
`Backup`	`withType(String type)` The type of the file-system backup.
`Backup`	`withVolume(Volume volume)`

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

- Constructor Detail
  - Backup
```
public Backup()
```
- Method Detail
  - setBackupId
```
public void setBackupId(String backupId)
```
    The ID of the backup.
    
    Parameters:
    
    backupId - The ID of the backup.
  - getBackupId
```
public String getBackupId()
```
    The ID of the backup.
    
    Returns:
    
    The ID of the backup.
  - withBackupId
```
public Backup withBackupId(String backupId)
```
    The ID of the backup.
    
    Parameters:
    
    backupId - The ID of the backup.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLifecycle
```
public void setLifecycle(String 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.
    Parameters:
    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.
    See Also:
    
    BackupLifecycle
  - getLifecycle
```
public String getLifecycle()
```
    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.
    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:
    
    BackupLifecycle
  - withLifecycle
```
public Backup withLifecycle(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BackupLifecycle
  - withLifecycle
```
public Backup withLifecycle(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BackupLifecycle
  - setFailureDetails
```
public void setFailureDetails(BackupFailureDetails failureDetails)
```
    Details explaining any failures that occurred when creating a backup.
    
    Parameters:
    
    failureDetails - Details explaining any failures that occurred when creating a backup.
  - getFailureDetails
```
public BackupFailureDetails getFailureDetails()
```
    Details explaining any failures that occurred when creating a backup.
    
    Returns:
    
    Details explaining any failures that occurred when creating a backup.
  - withFailureDetails
```
public Backup withFailureDetails(BackupFailureDetails failureDetails)
```
    Details explaining any failures that occurred when creating a backup.
    
    Parameters:
    
    failureDetails - Details explaining any failures that occurred when creating a backup.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of the file-system backup.
    
    Parameters:
    
    type - The type of the file-system backup.
    
    See Also:
    
    BackupType
  - getType
```
public String getType()
```
    The type of the file-system backup.
    
    Returns:
    
    The type of the file-system backup.
    
    See Also:
    
    BackupType
  - withType
```
public Backup withType(String type)
```
    The type of the file-system backup.
    
    Parameters:
    
    type - The type of the file-system backup.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BackupType
  - withType
```
public Backup withType(BackupType type)
```
    The type of the file-system backup.
    
    Parameters:
    
    type - The type of the file-system backup.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BackupType
  - setProgressPercent
```
public void setProgressPercent(Integer progressPercent)
```
    Parameters:
    
    progressPercent -
  - getProgressPercent
```
public Integer getProgressPercent()
```
    Returns:
  - withProgressPercent
```
public Backup withProgressPercent(Integer progressPercent)
```
    Parameters:
    
    progressPercent -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The time when a particular backup was created.
    
    Parameters:
    
    creationTime - The time when a particular backup was created.
  - getCreationTime
```
public Date getCreationTime()
```
    The time when a particular backup was created.
    
    Returns:
    
    The time when a particular backup was created.
  - withCreationTime
```
public Backup withCreationTime(Date creationTime)
```
    The time when a particular backup was created.
    
    Parameters:
    
    creationTime - The time when a particular backup was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKmsKeyId
```
public void setKmsKeyId(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.
    
    Parameters:
    
    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.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    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.
  - withKmsKeyId
```
public Backup withKmsKeyId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceARN
```
public void setResourceARN(String resourceARN)
```
    The Amazon Resource Name (ARN) for the backup resource.
    
    Parameters:
    
    resourceARN - The Amazon Resource Name (ARN) for the backup resource.
  - getResourceARN
```
public String getResourceARN()
```
    The Amazon Resource Name (ARN) for the backup resource.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the backup resource.
  - withResourceARN
```
public Backup withResourceARN(String resourceARN)
```
    The Amazon Resource Name (ARN) for the backup resource.
    
    Parameters:
    
    resourceARN - The Amazon Resource Name (ARN) for the backup resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    The tags associated with a particular file system.
    
    Returns:
    
    The tags associated with a particular file system.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    The tags associated with a particular file system.
    
    Parameters:
    
    tags - The tags associated with a particular file system.
  - withTags
```
public Backup withTags(Tag... tags)
```
    The tags associated with a particular file system.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - The tags associated with a particular file system.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public Backup withTags(Collection<Tag> tags)
```
    The tags associated with a particular file system.
    
    Parameters:
    
    tags - The tags associated with a particular file system.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFileSystem
```
public void setFileSystem(FileSystem fileSystem)
```
    The metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.
    
    Parameters:
    
    fileSystem - The metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.
  - getFileSystem
```
public FileSystem getFileSystem()
```
    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.
  - withFileSystem
```
public Backup withFileSystem(FileSystem fileSystem)
```
    The metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.
    
    Parameters:
    
    fileSystem - The metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDirectoryInformation
```
public void setDirectoryInformation(ActiveDirectoryBackupAttributes directoryInformation)
```
    The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.
    
    Parameters:
    
    directoryInformation - The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.
  - getDirectoryInformation
```
public ActiveDirectoryBackupAttributes getDirectoryInformation()
```
    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.
  - withDirectoryInformation
```
public Backup withDirectoryInformation(ActiveDirectoryBackupAttributes directoryInformation)
```
    The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.
    
    Parameters:
    
    directoryInformation - The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOwnerId
```
public void setOwnerId(String ownerId)
```
    Parameters:
    
    ownerId -
  - getOwnerId
```
public String getOwnerId()
```
    Returns:
  - withOwnerId
```
public Backup withOwnerId(String ownerId)
```
    Parameters:
    
    ownerId -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceBackupId
```
public void setSourceBackupId(String sourceBackupId)
```
    Parameters:
    
    sourceBackupId -
  - getSourceBackupId
```
public String getSourceBackupId()
```
    Returns:
  - withSourceBackupId
```
public Backup withSourceBackupId(String sourceBackupId)
```
    Parameters:
    
    sourceBackupId -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceBackupRegion
```
public void setSourceBackupRegion(String sourceBackupRegion)
```
    The source Region of the backup. Specifies the Region from where this backup is copied.
    
    Parameters:
    
    sourceBackupRegion - The source Region of the backup. Specifies the Region from where this backup is copied.
  - getSourceBackupRegion
```
public String getSourceBackupRegion()
```
    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.
  - withSourceBackupRegion
```
public Backup withSourceBackupRegion(String sourceBackupRegion)
```
    The source Region of the backup. Specifies the Region from where this backup is copied.
    
    Parameters:
    
    sourceBackupRegion - The source Region of the backup. Specifies the Region from where this backup is copied.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceType
```
public void setResourceType(String resourceType)
```
    Specifies the resource type that's backed up.
    
    Parameters:
    
    resourceType - Specifies the resource type that's backed up.
    
    See Also:
    
    ResourceType
  - getResourceType
```
public String getResourceType()
```
    Specifies the resource type that's backed up.
    
    Returns:
    
    Specifies the resource type that's backed up.
    
    See Also:
    
    ResourceType
  - withResourceType
```
public Backup withResourceType(String resourceType)
```
    Specifies the resource type that's backed up.
    
    Parameters:
    
    resourceType - Specifies the resource type that's backed up.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceType
  - withResourceType
```
public Backup withResourceType(ResourceType resourceType)
```
    Specifies the resource type that's backed up.
    
    Parameters:
    
    resourceType - Specifies the resource type that's backed up.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceType
  - setVolume
```
public void setVolume(Volume volume)
```
    Parameters:
    
    volume -
  - getVolume
```
public Volume getVolume()
```
    Returns:
  - withVolume
```
public Backup withVolume(Volume volume)
```
    Parameters:
    
    volume -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Backup clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class Backup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Backup

Method Detail

setBackupId

getBackupId

withBackupId

setLifecycle

getLifecycle

withLifecycle

withLifecycle

setFailureDetails

getFailureDetails

withFailureDetails

setType

getType

withType

withType

setProgressPercent

getProgressPercent

withProgressPercent

setCreationTime

getCreationTime

withCreationTime

setKmsKeyId

getKmsKeyId

withKmsKeyId

setResourceARN

getResourceARN

withResourceARN

getTags

setTags

withTags

withTags

setFileSystem

getFileSystem

withFileSystem

setDirectoryInformation

getDirectoryInformation

withDirectoryInformation

setOwnerId

getOwnerId

withOwnerId

setSourceBackupId

getSourceBackupId

withSourceBackupId

setSourceBackupRegion

getSourceBackupRegion

withSourceBackupRegion

setResourceType

getResourceType

withResourceType

withResourceType

setVolume

getVolume

withVolume

toString

equals

hashCode

clone

marshall