java.lang.Object
- software.amazon.awssdk.services.cloudhsmv2.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>
```
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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Backup.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`backupArn()`	The Amazon Resource Name (ARN) of the backup.
`String`	`backupId()`	The identifier (ID) of the backup.
`BackupState`	`backupState()`	The state of the backup.
`String`	`backupStateAsString()`	The state of the backup.
`static Backup.Builder`	`builder()`
`String`	`clusterId()`	The identifier (ID) of the cluster that was backed up.
`Instant`	`copyTimestamp()`	The date and time when the backup was copied from a source backup.
`Instant`	`createTimestamp()`	The date and time when the backup was created.
`Instant`	`deleteTimestamp()`	The date and time when the backup will be permanently deleted.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTagList()`	For responses, this returns true if the service returned a value for the TagList property.
`String`	`hsmType()`	The HSM type used to create the backup.
`ClusterMode`	`mode()`	The mode of the cluster that was backed up.
`String`	`modeAsString()`	The mode of the cluster that was backed up.
`Boolean`	`neverExpires()`	Specifies whether the service should exempt a backup from the retention policy for the cluster.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Backup.Builder>`	`serializableBuilderClass()`
`String`	`sourceBackup()`	The identifier (ID) of the source backup from which the new backup was copied.
`String`	`sourceCluster()`	The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
`String`	`sourceRegion()`	The AWS Region that contains the source backup from which the new backup was copied.
`List<Tag>`	`tagList()`	The list of tags for the backup.
`Backup.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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

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

- Method Detail
  - backupId
```
public final String backupId()
```
    The identifier (ID) of the backup.
    
    Returns:
    
    The identifier (ID) of the backup.
  - backupArn
```
public final String backupArn()
```
    The Amazon Resource Name (ARN) of the backup.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the backup.
  - backupState
```
public final BackupState backupState()
```
    The state of the backup.
    
    If the service returns an enum value that is not available in the current SDK version, backupState will return BackupState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from backupStateAsString().
    
    Returns:
    
    The state of the backup.
    
    See Also:
    
    BackupState
  - backupStateAsString
```
public final String backupStateAsString()
```
    The state of the backup.
    
    If the service returns an enum value that is not available in the current SDK version, backupState will return BackupState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from backupStateAsString().
    
    Returns:
    
    The state of the backup.
    
    See Also:
    
    BackupState
  - clusterId
```
public final String clusterId()
```
    The identifier (ID) of the cluster that was backed up.
    
    Returns:
    
    The identifier (ID) of the cluster that was backed up.
  - createTimestamp
```
public final Instant createTimestamp()
```
    The date and time when the backup was created.
    
    Returns:
    
    The date and time when the backup was created.
  - copyTimestamp
```
public final Instant copyTimestamp()
```
    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.
  - neverExpires
```
public final 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.
    
    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.
  - sourceRegion
```
public final String sourceRegion()
```
    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.
  - sourceBackup
```
public final String sourceBackup()
```
    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.
  - sourceCluster
```
public final String sourceCluster()
```
    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.
  - deleteTimestamp
```
public final Instant deleteTimestamp()
```
    The date and time when the backup will be permanently deleted.
    
    Returns:
    
    The date and time when the backup will be permanently deleted.
  - hasTagList
```
public final boolean hasTagList()
```
    For responses, this returns true if the service returned a value for the TagList 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.
  - tagList
```
public final List<Tag> tagList()
```
    The list of tags for the backup.
    
    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 hasTagList() method.
    
    Returns:
    
    The list of tags for the backup.
  - hsmType
```
public final String hsmType()
```
    The HSM type used to create the backup.
    
    Returns:
    
    The HSM type used to create the backup.
  - mode
```
public final ClusterMode mode()
```
    The mode of the cluster that was backed up.
    
    If the service returns an enum value that is not available in the current SDK version, mode will return ClusterMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().
    
    Returns:
    
    The mode of the cluster that was backed up.
    
    See Also:
    
    ClusterMode
  - modeAsString
```
public final String modeAsString()
```
    The mode of the cluster that was backed up.
    
    If the service returns an enum value that is not available in the current SDK version, mode will return ClusterMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().
    
    Returns:
    
    The mode of the cluster that was backed up.
    
    See Also:
    
    ClusterMode
  - toBuilder
```
public Backup.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Backup.Builder,Backup>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

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

backupArn

backupState

backupStateAsString

clusterId

createTimestamp

copyTimestamp

neverExpires

sourceRegion

sourceBackup

sourceCluster

deleteTimestamp

hasTagList

tagList

hsmType

mode

modeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField