java.lang.Object
- software.amazon.awssdk.services.redshiftserverless.model.Snapshot

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Snapshot.Builder,Snapshot>

@Generated("software.amazon.awssdk:codegen")
public final class Snapshot
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Snapshot.Builder,Snapshot>

A snapshot object that contains databases.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Snapshot.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<String>`	`accountsWithProvisionedRestoreAccess()`	All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.
`List<String>`	`accountsWithRestoreAccess()`	All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.
`Double`	`actualIncrementalBackupSizeInMegaBytes()`	The size of the incremental backup in megabytes.
`String`	`adminPasswordSecretArn()`	The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
`String`	`adminPasswordSecretKmsKeyId()`	The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
`String`	`adminUsername()`	The username of the database within a snapshot.
`Double`	`backupProgressInMegaBytes()`	The size in megabytes of the data that has been backed up to a snapshot.
`static Snapshot.Builder`	`builder()`
`Double`	`currentBackupRateInMegaBytesPerSecond()`	The rate at which data is backed up into a snapshot in megabytes per second.
`Long`	`elapsedTimeInSeconds()`	The amount of time it took to back up data into a snapshot.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Long`	`estimatedSecondsToCompletion()`	The estimated amount of seconds until the snapshot completes backup.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAccountsWithProvisionedRestoreAccess()`	For responses, this returns true if the service returned a value for the AccountsWithProvisionedRestoreAccess property.
`boolean`	`hasAccountsWithRestoreAccess()`	For responses, this returns true if the service returned a value for the AccountsWithRestoreAccess property.
`int`	`hashCode()`
`String`	`kmsKeyId()`	The unique identifier of the KMS key used to encrypt the snapshot.
`String`	`namespaceArn()`	The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
`String`	`namespaceName()`	The name of the namepsace.
`String`	`ownerAccount()`	The owner Amazon Web Services; account of the snapshot.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Snapshot.Builder>`	`serializableBuilderClass()`
`String`	`snapshotArn()`	The Amazon Resource Name (ARN) of the snapshot.
`Instant`	`snapshotCreateTime()`	The timestamp of when the snapshot was created.
`String`	`snapshotName()`	The name of the snapshot.
`Integer`	`snapshotRemainingDays()`	The amount of days until the snapshot is deleted.
`Integer`	`snapshotRetentionPeriod()`	The period of time, in days, of how long the snapshot is retained.
`Instant`	`snapshotRetentionStartTime()`	The timestamp of when data within the snapshot started getting retained.
`SnapshotStatus`	`status()`	The status of the snapshot.
`String`	`statusAsString()`	The status of the snapshot.
`Snapshot.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Double`	`totalBackupSizeInMegaBytes()`	The total size, in megabytes, of how big the snapshot is.

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
  - 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 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.
  - accountsWithProvisionedRestoreAccess
```
public final List<String> 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 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.
  - accountsWithRestoreAccess
```
public final List<String> 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
```
public final Double actualIncrementalBackupSizeInMegaBytes()
```
    The size of the incremental backup in megabytes.
    
    Returns:
    
    The size of the incremental backup in megabytes.
  - adminPasswordSecretArn
```
public final String 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
```
public final String 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
```
public final String adminUsername()
```
    The username of the database within a snapshot.
    
    Returns:
    
    The username of the database within a snapshot.
  - backupProgressInMegaBytes
```
public final Double 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
```
public final Double 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
```
public final Long 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
```
public final Long estimatedSecondsToCompletion()
```
    The estimated amount of seconds until the snapshot completes backup.
    
    Returns:
    
    The estimated amount of seconds until the snapshot completes backup.
  - kmsKeyId
```
public final String 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
```
public final String 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
```
public final String namespaceName()
```
    The name of the namepsace.
    
    Returns:
    
    The name of the namepsace.
  - ownerAccount
```
public final String ownerAccount()
```
    The owner Amazon Web Services; account of the snapshot.
    
    Returns:
    
    The owner Amazon Web Services; account of the snapshot.
  - snapshotArn
```
public final String snapshotArn()
```
    The Amazon Resource Name (ARN) of the snapshot.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the snapshot.
  - snapshotCreateTime
```
public final Instant snapshotCreateTime()
```
    The timestamp of when the snapshot was created.
    
    Returns:
    
    The timestamp of when the snapshot was created.
  - snapshotName
```
public final String snapshotName()
```
    The name of the snapshot.
    
    Returns:
    
    The name of the snapshot.
  - snapshotRemainingDays
```
public final Integer snapshotRemainingDays()
```
    The amount of days until the snapshot is deleted.
    
    Returns:
    
    The amount of days until the snapshot is deleted.
  - snapshotRetentionPeriod
```
public final Integer 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
```
public final Instant 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
```
public final SnapshotStatus status()
```
    The status of the snapshot.
    
    If the service returns an enum value that is not available in the current SDK version, status will return SnapshotStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the snapshot.
    
    See Also:
    
    SnapshotStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the snapshot.
    
    If the service returns an enum value that is not available in the current SDK version, status will return SnapshotStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the snapshot.
    
    See Also:
    
    SnapshotStatus
  - totalBackupSizeInMegaBytes
```
public final Double 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
```
public Snapshot.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Snapshot.Builder,Snapshot>
  - builder
```
public static Snapshot.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Snapshot.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

Class Snapshot

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasAccountsWithProvisionedRestoreAccess

accountsWithProvisionedRestoreAccess

hasAccountsWithRestoreAccess

accountsWithRestoreAccess

actualIncrementalBackupSizeInMegaBytes

adminPasswordSecretArn

adminPasswordSecretKmsKeyId

adminUsername

backupProgressInMegaBytes

currentBackupRateInMegaBytesPerSecond

elapsedTimeInSeconds

estimatedSecondsToCompletion

kmsKeyId

namespaceArn

namespaceName

ownerAccount

snapshotArn

snapshotCreateTime

snapshotName

snapshotRemainingDays

snapshotRetentionPeriod

snapshotRetentionStartTime

status

statusAsString

totalBackupSizeInMegaBytes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields