Backup (AWS Java SDK for AWS CloudHSM V2 1.12.787 API)

java.lang.Object
- com.amazonaws.services.cloudhsmv2.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
```
Contains information about a backup of an CloudHSM cluster. All backup objects contain the BackupId, BackupState, ClusterId, and CreateTimestamp parameters. Backups that were copied into a destination region additionally contain the CopyTimestamp, SourceBackup, SourceCluster, and SourceRegion parameters. A backup that is pending deletion will include the DeleteTimestamp parameter.

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`	`getBackupArn()` The Amazon Resource Name (ARN) of the backup.
`String`	`getBackupId()` The identifier (ID) of the backup.
`String`	`getBackupState()` The state of the backup.
`String`	`getClusterId()` The identifier (ID) of the cluster that was backed up.
`Date`	`getCopyTimestamp()` The date and time when the backup was copied from a source backup.
`Date`	`getCreateTimestamp()` The date and time when the backup was created.
`Date`	`getDeleteTimestamp()` The date and time when the backup will be permanently deleted.
`String`	`getHsmType()` The HSM type used to create the backup.
`String`	`getMode()` The mode of the cluster that was backed up.
`Boolean`	`getNeverExpires()` Specifies whether the service should exempt a backup from the retention policy for the cluster.
`String`	`getSourceBackup()` The identifier (ID) of the source backup from which the new backup was copied.
`String`	`getSourceCluster()` The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
`String`	`getSourceRegion()` The AWS Region that contains the source backup from which the new backup was copied.
`List<Tag>`	`getTagList()` The list of tags for the backup.
`int`	`hashCode()`
`Boolean`	`isNeverExpires()` Specifies whether the service should exempt a backup from the retention policy for the cluster.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setBackupArn(String backupArn)` The Amazon Resource Name (ARN) of the backup.
`void`	`setBackupId(String backupId)` The identifier (ID) of the backup.
`void`	`setBackupState(String backupState)` The state of the backup.
`void`	`setClusterId(String clusterId)` The identifier (ID) of the cluster that was backed up.
`void`	`setCopyTimestamp(Date copyTimestamp)` The date and time when the backup was copied from a source backup.
`void`	`setCreateTimestamp(Date createTimestamp)` The date and time when the backup was created.
`void`	`setDeleteTimestamp(Date deleteTimestamp)` The date and time when the backup will be permanently deleted.
`void`	`setHsmType(String hsmType)` The HSM type used to create the backup.
`void`	`setMode(String mode)` The mode of the cluster that was backed up.
`void`	`setNeverExpires(Boolean neverExpires)` Specifies whether the service should exempt a backup from the retention policy for the cluster.
`void`	`setSourceBackup(String sourceBackup)` The identifier (ID) of the source backup from which the new backup was copied.
`void`	`setSourceCluster(String sourceCluster)` The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
`void`	`setSourceRegion(String sourceRegion)` The AWS Region that contains the source backup from which the new backup was copied.
`void`	`setTagList(Collection<Tag> tagList)` The list of tags for the backup.
`String`	`toString()` Returns a string representation of this object.
`Backup`	`withBackupArn(String backupArn)` The Amazon Resource Name (ARN) of the backup.
`Backup`	`withBackupId(String backupId)` The identifier (ID) of the backup.
`Backup`	`withBackupState(BackupState backupState)` The state of the backup.
`Backup`	`withBackupState(String backupState)` The state of the backup.
`Backup`	`withClusterId(String clusterId)` The identifier (ID) of the cluster that was backed up.
`Backup`	`withCopyTimestamp(Date copyTimestamp)` The date and time when the backup was copied from a source backup.
`Backup`	`withCreateTimestamp(Date createTimestamp)` The date and time when the backup was created.
`Backup`	`withDeleteTimestamp(Date deleteTimestamp)` The date and time when the backup will be permanently deleted.
`Backup`	`withHsmType(String hsmType)` The HSM type used to create the backup.
`Backup`	`withMode(ClusterMode mode)` The mode of the cluster that was backed up.
`Backup`	`withMode(String mode)` The mode of the cluster that was backed up.
`Backup`	`withNeverExpires(Boolean neverExpires)` Specifies whether the service should exempt a backup from the retention policy for the cluster.
`Backup`	`withSourceBackup(String sourceBackup)` The identifier (ID) of the source backup from which the new backup was copied.
`Backup`	`withSourceCluster(String sourceCluster)` The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
`Backup`	`withSourceRegion(String sourceRegion)` The AWS Region that contains the source backup from which the new backup was copied.
`Backup`	`withTagList(Collection<Tag> tagList)` The list of tags for the backup.
`Backup`	`withTagList(Tag... tagList)` The list of tags for the backup.

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

- Constructor Detail
  - Backup
```
public Backup()
```
- Method Detail
  - setBackupId
```
public void setBackupId(String backupId)
```
    The identifier (ID) of the backup.
    
    Parameters:
    
    backupId - The identifier (ID) of the backup.
  - getBackupId
```
public String getBackupId()
```
    The identifier (ID) of the backup.
    
    Returns:
    
    The identifier (ID) of the backup.
  - withBackupId
```
public Backup withBackupId(String backupId)
```
    The identifier (ID) of the backup.
    
    Parameters:
    
    backupId - The identifier (ID) of the backup.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBackupArn
```
public void setBackupArn(String backupArn)
```
    The Amazon Resource Name (ARN) of the backup.
    
    Parameters:
    
    backupArn - The Amazon Resource Name (ARN) of the backup.
  - getBackupArn
```
public String getBackupArn()
```
    The Amazon Resource Name (ARN) of the backup.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the backup.
  - withBackupArn
```
public Backup withBackupArn(String backupArn)
```
    The Amazon Resource Name (ARN) of the backup.
    
    Parameters:
    
    backupArn - The Amazon Resource Name (ARN) of the backup.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBackupState
```
public void setBackupState(String backupState)
```
    The state of the backup.
    
    Parameters:
    
    backupState - The state of the backup.
    
    See Also:
    
    BackupState
  - getBackupState
```
public String getBackupState()
```
    The state of the backup.
    
    Returns:
    
    The state of the backup.
    
    See Also:
    
    BackupState
  - withBackupState
```
public Backup withBackupState(String backupState)
```
    The state of the backup.
    
    Parameters:
    
    backupState - The state of the backup.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BackupState
  - withBackupState
```
public Backup withBackupState(BackupState backupState)
```
    The state of the backup.
    
    Parameters:
    
    backupState - The state of the backup.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BackupState
  - setClusterId
```
public void setClusterId(String clusterId)
```
    The identifier (ID) of the cluster that was backed up.
    
    Parameters:
    
    clusterId - The identifier (ID) of the cluster that was backed up.
  - getClusterId
```
public String getClusterId()
```
    The identifier (ID) of the cluster that was backed up.
    
    Returns:
    
    The identifier (ID) of the cluster that was backed up.
  - withClusterId
```
public Backup withClusterId(String clusterId)
```
    The identifier (ID) of the cluster that was backed up.
    
    Parameters:
    
    clusterId - The identifier (ID) of the cluster that was backed up.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreateTimestamp
```
public void setCreateTimestamp(Date createTimestamp)
```
    The date and time when the backup was created.
    
    Parameters:
    
    createTimestamp - The date and time when the backup was created.
  - getCreateTimestamp
```
public Date getCreateTimestamp()
```
    The date and time when the backup was created.
    
    Returns:
    
    The date and time when the backup was created.
  - withCreateTimestamp
```
public Backup withCreateTimestamp(Date createTimestamp)
```
    The date and time when the backup was created.
    
    Parameters:
    
    createTimestamp - The date and time when the backup was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCopyTimestamp
```
public void setCopyTimestamp(Date copyTimestamp)
```
    The date and time when the backup was copied from a source backup.
    
    Parameters:
    
    copyTimestamp - The date and time when the backup was copied from a source backup.
  - getCopyTimestamp
```
public Date getCopyTimestamp()
```
    The date and time when the backup was copied from a source backup.
    
    Returns:
    
    The date and time when the backup was copied from a source backup.
  - withCopyTimestamp
```
public Backup withCopyTimestamp(Date copyTimestamp)
```
    The date and time when the backup was copied from a source backup.
    
    Parameters:
    
    copyTimestamp - The date and time when the backup was copied from a source backup.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNeverExpires
```
public void setNeverExpires(Boolean neverExpires)
```
    Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.
    
    Parameters:
    
    neverExpires - Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.
  - getNeverExpires
```
public Boolean getNeverExpires()
```
    Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.
    
    Returns:
    
    Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.
  - withNeverExpires
```
public Backup withNeverExpires(Boolean neverExpires)
```
    Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.
    
    Parameters:
    
    neverExpires - Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isNeverExpires
```
public Boolean isNeverExpires()
```
    Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.
    
    Returns:
    
    Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.
  - setSourceRegion
```
public void setSourceRegion(String sourceRegion)
```
    The AWS Region that contains the source backup from which the new backup was copied.
    
    Parameters:
    
    sourceRegion - The AWS Region that contains the source backup from which the new backup was copied.
  - getSourceRegion
```
public String getSourceRegion()
```
    The AWS Region that contains the source backup from which the new backup was copied.
    
    Returns:
    
    The AWS Region that contains the source backup from which the new backup was copied.
  - withSourceRegion
```
public Backup withSourceRegion(String sourceRegion)
```
    The AWS Region that contains the source backup from which the new backup was copied.
    
    Parameters:
    
    sourceRegion - The AWS Region that contains the source backup from which the new backup was copied.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceBackup
```
public void setSourceBackup(String sourceBackup)
```
    The identifier (ID) of the source backup from which the new backup was copied.
    
    Parameters:
    
    sourceBackup - The identifier (ID) of the source backup from which the new backup was copied.
  - getSourceBackup
```
public String getSourceBackup()
```
    The identifier (ID) of the source backup from which the new backup was copied.
    
    Returns:
    
    The identifier (ID) of the source backup from which the new backup was copied.
  - withSourceBackup
```
public Backup withSourceBackup(String sourceBackup)
```
    The identifier (ID) of the source backup from which the new backup was copied.
    
    Parameters:
    
    sourceBackup - The identifier (ID) of the source backup from which the new backup was copied.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceCluster
```
public void setSourceCluster(String sourceCluster)
```
    The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
    
    Parameters:
    
    sourceCluster - The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
  - getSourceCluster
```
public String getSourceCluster()
```
    The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
    
    Returns:
    
    The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
  - withSourceCluster
```
public Backup withSourceCluster(String sourceCluster)
```
    The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
    
    Parameters:
    
    sourceCluster - The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeleteTimestamp
```
public void setDeleteTimestamp(Date deleteTimestamp)
```
    The date and time when the backup will be permanently deleted.
    
    Parameters:
    
    deleteTimestamp - The date and time when the backup will be permanently deleted.
  - getDeleteTimestamp
```
public Date getDeleteTimestamp()
```
    The date and time when the backup will be permanently deleted.
    
    Returns:
    
    The date and time when the backup will be permanently deleted.
  - withDeleteTimestamp
```
public Backup withDeleteTimestamp(Date deleteTimestamp)
```
    The date and time when the backup will be permanently deleted.
    
    Parameters:
    
    deleteTimestamp - The date and time when the backup will be permanently deleted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTagList
```
public List<Tag> getTagList()
```
    The list of tags for the backup.
    
    Returns:
    
    The list of tags for the backup.
  - setTagList
```
public void setTagList(Collection<Tag> tagList)
```
    The list of tags for the backup.
    
    Parameters:
    
    tagList - The list of tags for the backup.
  - withTagList
```
public Backup withTagList(Tag... tagList)
```
    The list of tags for the backup.
    
    NOTE: This method appends the values to the existing list (if any). Use setTagList(java.util.Collection) or withTagList(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tagList - The list of tags for the backup.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTagList
```
public Backup withTagList(Collection<Tag> tagList)
```
    The list of tags for the backup.
    
    Parameters:
    
    tagList - The list of tags for the backup.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHsmType
```
public void setHsmType(String hsmType)
```
    The HSM type used to create the backup.
    
    Parameters:
    
    hsmType - The HSM type used to create the backup.
  - getHsmType
```
public String getHsmType()
```
    The HSM type used to create the backup.
    
    Returns:
    
    The HSM type used to create the backup.
  - withHsmType
```
public Backup withHsmType(String hsmType)
```
    The HSM type used to create the backup.
    
    Parameters:
    
    hsmType - The HSM type used to create the backup.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMode
```
public void setMode(String mode)
```
    The mode of the cluster that was backed up.
    
    Parameters:
    
    mode - The mode of the cluster that was backed up.
    
    See Also:
    
    ClusterMode
  - getMode
```
public String getMode()
```
    The mode of the cluster that was backed up.
    
    Returns:
    
    The mode of the cluster that was backed up.
    
    See Also:
    
    ClusterMode
  - withMode
```
public Backup withMode(String mode)
```
    The mode of the cluster that was backed up.
    
    Parameters:
    
    mode - The mode of the cluster that was backed up.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ClusterMode
  - withMode
```
public Backup withMode(ClusterMode mode)
```
    The mode of the cluster that was backed up.
    
    Parameters:
    
    mode - The mode of the cluster that was backed up.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ClusterMode
  - 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)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class Backup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Backup

Method Detail

setBackupId

getBackupId

withBackupId

setBackupArn

getBackupArn

withBackupArn

setBackupState

getBackupState

withBackupState

withBackupState

setClusterId

getClusterId

withClusterId

setCreateTimestamp

getCreateTimestamp

withCreateTimestamp

setCopyTimestamp

getCopyTimestamp

withCopyTimestamp

setNeverExpires

getNeverExpires

withNeverExpires

isNeverExpires

setSourceRegion

getSourceRegion

withSourceRegion

setSourceBackup

getSourceBackup

withSourceBackup

setSourceCluster

getSourceCluster

withSourceCluster

setDeleteTimestamp

getDeleteTimestamp

withDeleteTimestamp

getTagList

setTagList

withTagList

withTagList

setHsmType

getHsmType

withHsmType

setMode

getMode

withMode

withMode

toString

equals

hashCode

clone

marshall