Class Snapshot
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Snapshot.Builder,
Snapshot>
A snapshot object that contains databases.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionAll of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.final Double
The size of the incremental backup in megabytes.final String
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.final String
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.final String
The username of the database within a snapshot.final Double
The size in megabytes of the data that has been backed up to a snapshot.static Snapshot.Builder
builder()
final Double
The rate at which data is backed up into a snapshot in megabytes per second.final Long
The amount of time it took to back up data into a snapshot.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Long
The estimated amount of seconds until the snapshot completes backup.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AccountsWithProvisionedRestoreAccess property.final boolean
For responses, this returns true if the service returned a value for the AccountsWithRestoreAccess property.final int
hashCode()
final String
kmsKeyId()
The unique identifier of the KMS key used to encrypt the snapshot.final String
The Amazon Resource Name (ARN) of the namespace the snapshot was created from.final String
The name of the namepsace.final String
The owner Amazon Web Services; account of the snapshot.static Class
<? extends Snapshot.Builder> final String
The Amazon Resource Name (ARN) of the snapshot.final Instant
The timestamp of when the snapshot was created.final String
The name of the snapshot.final Integer
The amount of days until the snapshot is deleted.final Integer
The period of time, in days, of how long the snapshot is retained.final Instant
The timestamp of when data within the snapshot started getting retained.final SnapshotStatus
status()
The status of the snapshot.final String
The status of the snapshot.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.final Double
The total size, in megabytes, of how big the snapshot is.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasAccountsWithProvisionedRestoreAccess
public final boolean hasAccountsWithProvisionedRestoreAccess()For responses, this returns true if the service returned a value for the AccountsWithProvisionedRestoreAccess 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. -
accountsWithProvisionedRestoreAccess
All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.
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
hasAccountsWithProvisionedRestoreAccess()
method.- Returns:
- All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.
-
hasAccountsWithRestoreAccess
public final boolean hasAccountsWithRestoreAccess()For responses, this returns true if the service returned a value for the AccountsWithRestoreAccess 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. -
accountsWithRestoreAccess
All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.
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
hasAccountsWithRestoreAccess()
method.- Returns:
- All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.
-
actualIncrementalBackupSizeInMegaBytes
The size of the incremental backup in megabytes.
- Returns:
- The size of the incremental backup in megabytes.
-
adminPasswordSecretArn
The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
- Returns:
- The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
-
adminPasswordSecretKmsKeyId
The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
- Returns:
- The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
-
adminUsername
The username of the database within a snapshot.
- Returns:
- The username of the database within a snapshot.
-
backupProgressInMegaBytes
The size in megabytes of the data that has been backed up to a snapshot.
- Returns:
- The size in megabytes of the data that has been backed up to a snapshot.
-
currentBackupRateInMegaBytesPerSecond
The rate at which data is backed up into a snapshot in megabytes per second.
- Returns:
- The rate at which data is backed up into a snapshot in megabytes per second.
-
elapsedTimeInSeconds
The amount of time it took to back up data into a snapshot.
- Returns:
- The amount of time it took to back up data into a snapshot.
-
estimatedSecondsToCompletion
The estimated amount of seconds until the snapshot completes backup.
- Returns:
- The estimated amount of seconds until the snapshot completes backup.
-
kmsKeyId
The unique identifier of the KMS key used to encrypt the snapshot.
- Returns:
- The unique identifier of the KMS key used to encrypt the snapshot.
-
namespaceArn
The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
- Returns:
- The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
-
namespaceName
The name of the namepsace.
- Returns:
- The name of the namepsace.
-
ownerAccount
The owner Amazon Web Services; account of the snapshot.
- Returns:
- The owner Amazon Web Services; account of the snapshot.
-
snapshotArn
The Amazon Resource Name (ARN) of the snapshot.
- Returns:
- The Amazon Resource Name (ARN) of the snapshot.
-
snapshotCreateTime
The timestamp of when the snapshot was created.
- Returns:
- The timestamp of when the snapshot was created.
-
snapshotName
The name of the snapshot.
- Returns:
- The name of the snapshot.
-
snapshotRemainingDays
The amount of days until the snapshot is deleted.
- Returns:
- The amount of days until the snapshot is deleted.
-
snapshotRetentionPeriod
The period of time, in days, of how long the snapshot is retained.
- Returns:
- The period of time, in days, of how long the snapshot is retained.
-
snapshotRetentionStartTime
The timestamp of when data within the snapshot started getting retained.
- Returns:
- The timestamp of when data within the snapshot started getting retained.
-
status
The status of the snapshot.
If the service returns an enum value that is not available in the current SDK version,
status
will returnSnapshotStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the snapshot.
- See Also:
-
statusAsString
The status of the snapshot.
If the service returns an enum value that is not available in the current SDK version,
status
will returnSnapshotStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the snapshot.
- See Also:
-
totalBackupSizeInMegaBytes
The total size, in megabytes, of how big the snapshot is.
- Returns:
- The total size, in megabytes, of how big the snapshot is.
-
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<Snapshot.Builder,
Snapshot> - 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
-