DescribeRecoveryPointResponse (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.backup.model.BackupResponse
    - - software.amazon.awssdk.services.backup.model.DescribeRecoveryPointResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeRecoveryPointResponse.Builder,DescribeRecoveryPointResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeRecoveryPointResponse
extends BackupResponse
implements ToCopyableBuilder<DescribeRecoveryPointResponse.Builder,DescribeRecoveryPointResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeRecoveryPointResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeRecoveryPointResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long`	`backupSizeInBytes()` The size, in bytes, of a backup.
`String`	`backupVaultArn()` An ARN that uniquely identifies a backup vault; for example, `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
`String`	`backupVaultName()` The name of a logical container where backups are stored.
`static DescribeRecoveryPointResponse.Builder`	`builder()`
`CalculatedLifecycle`	`calculatedLifecycle()` A `CalculatedLifecycle` object containing `DeleteAt` and `MoveToColdStorageAt` timestamps.
`Instant`	`completionDate()` The date and time that a job to create a recovery point is completed, in Unix format and Coordinated Universal Time (UTC).
`String`	`compositeMemberIdentifier()` This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack.
`RecoveryPointCreator`	`createdBy()` Contains identifying information about the creation of a recovery point, including the `BackupPlanArn`, `BackupPlanId`, `BackupPlanVersion`, and `BackupRuleId` of the backup plan used to create it.
`Instant`	`creationDate()` The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC).
`String`	`encryptionKeyArn()` The server-side encryption key used to protect your backups; for example, `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`iamRoleArn()` Specifies the IAM role ARN used to create the target recovery point; for example, `arn:aws:iam::123456789012:role/S3Access`.
`Boolean`	`isEncrypted()` A Boolean value that is returned as `TRUE` if the specified recovery point is encrypted, or `FALSE` if the recovery point is not encrypted.
`Boolean`	`isParent()` This returns the boolean value that a recovery point is a parent (composite) job.
`Instant`	`lastRestoreTime()` The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC).
`Lifecycle`	`lifecycle()` The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
`String`	`parentRecoveryPointArn()` This is an ARN that uniquely identifies a parent (composite) recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
`String`	`recoveryPointArn()` An ARN that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
`String`	`resourceArn()` An ARN that uniquely identifies a saved resource.
`String`	`resourceName()` This is the non-unique name of the resource that belongs to the specified backup.
`String`	`resourceType()` The type of Amazon Web Services resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeRecoveryPointResponse.Builder>`	`serializableBuilderClass()`
`String`	`sourceBackupVaultArn()` An Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed up in; for example, `arn:aws:backup:us-east-1:123456789012:vault:BackupVault`.
`RecoveryPointStatus`	`status()` A status code specifying the state of the recovery point.
`String`	`statusAsString()` A status code specifying the state of the recovery point.
`String`	`statusMessage()` A status message explaining the status of the recovery point.
`StorageClass`	`storageClass()` Specifies the storage class of the recovery point.
`String`	`storageClassAsString()` Specifies the storage class of the recovery point.
`DescribeRecoveryPointResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.backup.model.BackupResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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
  - recoveryPointArn
```
public final String recoveryPointArn()
```
    An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    
    Returns:
    
    An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
  - backupVaultName
```
public final String backupVaultName()
```
    The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    
    Returns:
    
    The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
  - backupVaultArn
```
public final String backupVaultArn()
```
    An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
    
    Returns:
    
    An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
  - sourceBackupVaultArn
```
public final String sourceBackupVaultArn()
```
    An Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed up in; for example, arn:aws:backup:us-east-1:123456789012:vault:BackupVault. If the recovery is restored to the same Amazon Web Services account or Region, this value will be null.
    
    Returns:
    
    An Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed up in; for example, arn:aws:backup:us-east-1:123456789012:vault:BackupVault. If the recovery is restored to the same Amazon Web Services account or Region, this value will be null.
  - resourceArn
```
public final String resourceArn()
```
    An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
    
    Returns:
    
    An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
  - resourceType
```
public final String resourceType()
```
    The type of Amazon Web Services resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
    
    Returns:
    
    The type of Amazon Web Services resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
  - createdBy
```
public final RecoveryPointCreator createdBy()
```
    Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.
    
    Returns:
    
    Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.
  - iamRoleArn
```
public final String iamRoleArn()
```
    Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    
    Returns:
    
    Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
  - status
```
public final RecoveryPointStatus status()
```
    A status code specifying the state of the recovery point.
    
    PARTIAL status indicates Backup could not create the recovery point before the backup window closed. To increase your backup plan window using the API, see UpdateBackupPlan. You can also increase your backup plan window using the Console by choosing and editing your backup plan.
    
    EXPIRED status indicates that the recovery point has exceeded its retention period, but Backup lacks permission or is otherwise unable to delete it. To manually delete these recovery points, see Step 3: Delete the recovery points in the Clean up resources section of Getting started.
    
    STOPPED status occurs on a continuous backup where a user has taken some action that causes the continuous backup to be disabled. This can be caused by the removal of permissions, turning off versioning, turning off events being sent to EventBridge, or disabling the EventBridge rules that are put in place by Backup.
    
    To resolve STOPPED status, ensure that all requested permissions are in place and that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance of a backup rule running will result in a new continuous recovery point being created. The recovery points with STOPPED status do not need to be deleted.
    
    For SAP HANA on Amazon EC2 STOPPED status occurs due to user action, application misconfiguration, or backup failure. To ensure that future continuous backups succeed, refer to the recovery point status and check SAP HANA for details.
    
    If the service returns an enum value that is not available in the current SDK version, status will return RecoveryPointStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    A status code specifying the state of the recovery point.
    
    PARTIAL status indicates Backup could not create the recovery point before the backup window closed. To increase your backup plan window using the API, see UpdateBackupPlan. You can also increase your backup plan window using the Console by choosing and editing your backup plan.
    
    EXPIRED status indicates that the recovery point has exceeded its retention period, but Backup lacks permission or is otherwise unable to delete it. To manually delete these recovery points, see Step 3: Delete the recovery points in the Clean up resources section of Getting started.
    
    STOPPED status occurs on a continuous backup where a user has taken some action that causes the continuous backup to be disabled. This can be caused by the removal of permissions, turning off versioning, turning off events being sent to EventBridge, or disabling the EventBridge rules that are put in place by Backup.
    
    To resolve STOPPED status, ensure that all requested permissions are in place and that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance of a backup rule running will result in a new continuous recovery point being created. The recovery points with STOPPED status do not need to be deleted.
    
    For SAP HANA on Amazon EC2 STOPPED status occurs due to user action, application misconfiguration, or backup failure. To ensure that future continuous backups succeed, refer to the recovery point status and check SAP HANA for details.
    
    See Also:
    
    RecoveryPointStatus
  - statusAsString
```
public final String statusAsString()
```
    A status code specifying the state of the recovery point.
    
    PARTIAL status indicates Backup could not create the recovery point before the backup window closed. To increase your backup plan window using the API, see UpdateBackupPlan. You can also increase your backup plan window using the Console by choosing and editing your backup plan.
    
    EXPIRED status indicates that the recovery point has exceeded its retention period, but Backup lacks permission or is otherwise unable to delete it. To manually delete these recovery points, see Step 3: Delete the recovery points in the Clean up resources section of Getting started.
    
    STOPPED status occurs on a continuous backup where a user has taken some action that causes the continuous backup to be disabled. This can be caused by the removal of permissions, turning off versioning, turning off events being sent to EventBridge, or disabling the EventBridge rules that are put in place by Backup.
    
    To resolve STOPPED status, ensure that all requested permissions are in place and that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance of a backup rule running will result in a new continuous recovery point being created. The recovery points with STOPPED status do not need to be deleted.
    
    For SAP HANA on Amazon EC2 STOPPED status occurs due to user action, application misconfiguration, or backup failure. To ensure that future continuous backups succeed, refer to the recovery point status and check SAP HANA for details.
    
    If the service returns an enum value that is not available in the current SDK version, status will return RecoveryPointStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    A status code specifying the state of the recovery point.
    
    PARTIAL status indicates Backup could not create the recovery point before the backup window closed. To increase your backup plan window using the API, see UpdateBackupPlan. You can also increase your backup plan window using the Console by choosing and editing your backup plan.
    
    EXPIRED status indicates that the recovery point has exceeded its retention period, but Backup lacks permission or is otherwise unable to delete it. To manually delete these recovery points, see Step 3: Delete the recovery points in the Clean up resources section of Getting started.
    
    STOPPED status occurs on a continuous backup where a user has taken some action that causes the continuous backup to be disabled. This can be caused by the removal of permissions, turning off versioning, turning off events being sent to EventBridge, or disabling the EventBridge rules that are put in place by Backup.
    
    To resolve STOPPED status, ensure that all requested permissions are in place and that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance of a backup rule running will result in a new continuous recovery point being created. The recovery points with STOPPED status do not need to be deleted.
    
    For SAP HANA on Amazon EC2 STOPPED status occurs due to user action, application misconfiguration, or backup failure. To ensure that future continuous backups succeed, refer to the recovery point status and check SAP HANA for details.
    
    See Also:
    
    RecoveryPointStatus
  - statusMessage
```
public final String statusMessage()
```
    A status message explaining the status of the recovery point.
    
    Returns:
    
    A status message explaining the status of the recovery point.
  - creationDate
```
public final Instant creationDate()
```
    The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    
    Returns:
    
    The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
  - completionDate
```
public final Instant completionDate()
```
    The date and time that a job to create a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    
    Returns:
    
    The date and time that a job to create a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
  - backupSizeInBytes
```
public final Long backupSizeInBytes()
```
    The size, in bytes, of a backup.
    
    Returns:
    
    The size, in bytes, of a backup.
  - calculatedLifecycle
```
public final CalculatedLifecycle calculatedLifecycle()
```
    A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.
    
    Returns:
    
    A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.
  - lifecycle
```
public final Lifecycle lifecycle()
```
    The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.
    
    Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
    
    Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
    
    Returns:
    
    The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.
    
    Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
    
    Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
  - encryptionKeyArn
```
public final String encryptionKeyArn()
```
    The server-side encryption key used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
    
    Returns:
    
    The server-side encryption key used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
  - isEncrypted
```
public final Boolean isEncrypted()
```
    A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.
    
    Returns:
    
    A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.
  - storageClass
```
public final StorageClass storageClass()
```
    Specifies the storage class of the recovery point. Valid values are WARM or COLD.
    
    If the service returns an enum value that is not available in the current SDK version, storageClass will return StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassAsString().
    
    Returns:
    
    Specifies the storage class of the recovery point. Valid values are WARM or COLD.
    
    See Also:
    
    StorageClass
  - storageClassAsString
```
public final String storageClassAsString()
```
    Specifies the storage class of the recovery point. Valid values are WARM or COLD.
    
    If the service returns an enum value that is not available in the current SDK version, storageClass will return StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassAsString().
    
    Returns:
    
    Specifies the storage class of the recovery point. Valid values are WARM or COLD.
    
    See Also:
    
    StorageClass
  - lastRestoreTime
```
public final Instant lastRestoreTime()
```
    The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    
    Returns:
    
    The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
  - parentRecoveryPointArn
```
public final String parentRecoveryPointArn()
```
    This is an ARN that uniquely identifies a parent (composite) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    
    Returns:
    
    This is an ARN that uniquely identifies a parent (composite) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
  - compositeMemberIdentifier
```
public final String compositeMemberIdentifier()
```
    This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.
    
    Returns:
    
    This is the identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.
  - isParent
```
public final Boolean isParent()
```
    This returns the boolean value that a recovery point is a parent (composite) job.
    
    Returns:
    
    This returns the boolean value that a recovery point is a parent (composite) job.
  - resourceName
```
public final String resourceName()
```
    This is the non-unique name of the resource that belongs to the specified backup.
    
    Returns:
    
    This is the non-unique name of the resource that belongs to the specified backup.
  - toBuilder
```
public DescribeRecoveryPointResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeRecoveryPointResponse.Builder,DescribeRecoveryPointResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeRecoveryPointResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeRecoveryPointResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeRecoveryPointResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.backup.model.BackupResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

recoveryPointArn

backupVaultName

backupVaultArn

sourceBackupVaultArn

resourceArn

resourceType

createdBy

iamRoleArn

status

statusAsString

statusMessage

creationDate

completionDate

backupSizeInBytes

calculatedLifecycle

lifecycle

encryptionKeyArn

isEncrypted

storageClass

storageClassAsString

lastRestoreTime

parentRecoveryPointArn

compositeMemberIdentifier

isParent

resourceName

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields