Class Backup
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Backup.Builder,
Backup>
Contains information about a backup of an AWS 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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
backupId()
The identifier (ID) of the backup.final BackupState
The state of the backup.final String
The state of the backup.static Backup.Builder
builder()
final String
The identifier (ID) of the cluster that was backed up.final Instant
The date and time when the backup was copied from a source backup.final Instant
The date and time when the backup was created.final Instant
The date and time when the backup will be permanently deleted.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the TagList property.final Boolean
Specifies whether the service should exempt a backup from the retention policy for the cluster.static Class
<? extends Backup.Builder> final String
The identifier (ID) of the source backup from which the new backup was copied.final String
The identifier (ID) of the cluster containing the source backup from which the new backup was copied.final String
The AWS Region that contains the source backup from which the new backup was copied.tagList()
The list of tags for the backup.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
backupId
The identifier (ID) of the backup.
- Returns:
- The identifier (ID) of the backup.
-
backupState
The state of the backup.
If the service returns an enum value that is not available in the current SDK version,
backupState
will returnBackupState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombackupStateAsString()
.- Returns:
- The state of the backup.
- See Also:
-
backupStateAsString
The state of the backup.
If the service returns an enum value that is not available in the current SDK version,
backupState
will returnBackupState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombackupStateAsString()
.- Returns:
- The state of the backup.
- See Also:
-
clusterId
The identifier (ID) of the cluster that was backed up.
- Returns:
- The identifier (ID) of the cluster that was backed up.
-
createTimestamp
The date and time when the backup was created.
- Returns:
- The date and time when the backup was created.
-
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
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
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
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
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
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 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. -
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.
-
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
-