java.lang.Object
- software.amazon.awssdk.services.backup.model.RecoveryPointByBackupVault

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RecoveryPointByBackupVault.Builder,RecoveryPointByBackupVault>
```
@Generated("software.amazon.awssdk:codegen")
public final class RecoveryPointByBackupVault
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RecoveryPointByBackupVault.Builder,RecoveryPointByBackupVault>
```
Contains detailed information about the recovery points stored in a backup vault.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface RecoveryPointByBackupVault.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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:backup-vault:aBackupVault`.
`String`	`backupVaultName()`	The name of a logical container where backups are stored.
`static RecoveryPointByBackupVault.Builder`	`builder()`
`CalculatedLifecycle`	`calculatedLifecycle()`	A `CalculatedLifecycle` object containing `DeleteAt` and `MoveToColdStorageAt` timestamps.
`Instant`	`completionDate()`	The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC).
`String`	`compositeMemberIdentifier()`	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 that is used to create it.
`Instant`	`creationDate()`	The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC).
`String`	`encryptionKeyArn()`	The server-side encryption key that is 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`.
`IndexStatus`	`indexStatus()`	This is the current status for the backup index associated with the specified recovery point.
`String`	`indexStatusAsString()`	This is the current status for the backup index associated with the specified recovery point.
`String`	`indexStatusMessage()`	A string in the form of a detailed message explaining the status of a backup index associated with the recovery point.
`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 is a boolean value indicating this is a parent (composite) recovery point.
`Instant`	`lastRestoreTime()`	The date and time 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()`	The Amazon Resource Name (ARN) of the parent (composite) recovery point.
`String`	`recoveryPointArn()`	An Amazon Resource Name (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 resource.
`String`	`resourceName()`	The non-unique name of the resource that belongs to the specified backup.
`String`	`resourceType()`	The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RecoveryPointByBackupVault.Builder>`	`serializableBuilderClass()`
`String`	`sourceBackupVaultArn()`	The backup vault where the recovery point was originally copied from.
`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 message explaining the current status of the recovery point.
`RecoveryPointByBackupVault.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`VaultType`	`vaultType()`	The type of vault in which the described recovery point is stored.
`String`	`vaultTypeAsString()`	The type of vault in which the described recovery point is stored.

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 Amazon Resource Name (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 Amazon Resource Name (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 Amazon Web Services Region where they are created.
    
    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 Amazon Web Services Region where they are created.
  - backupVaultArn
```
public final String backupVaultArn()
```
    An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
    
    Returns:
    
    An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
  - sourceBackupVaultArn
```
public final String sourceBackupVaultArn()
```
    The backup vault where the recovery point was originally copied from. If the recovery point is restored to the same account this value will be null.
    
    Returns:
    
    The backup vault where the recovery point was originally copied from. If the recovery point is restored to the same account this value will be null.
  - resourceArn
```
public final String resourceArn()
```
    An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
    
    Returns:
    
    An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
  - resourceType
```
public final String resourceType()
```
    The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
    
    Returns:
    
    The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.
  - 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 that is 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 that is 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.
    
    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.
    
    See Also:
    
    RecoveryPointStatus
  - statusAsString
```
public final String statusAsString()
```
    A status code specifying the state of the recovery point.
    
    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.
    
    See Also:
    
    RecoveryPointStatus
  - statusMessage
```
public final String statusMessage()
```
    A message explaining the current status of the recovery point.
    
    Returns:
    
    A message explaining the current status of the recovery point.
  - creationDate
```
public final Instant creationDate()
```
    The date and time 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 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 a job to restore 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 a job to restore 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 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 can transition to cold storage are listed in 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 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 can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.
  - encryptionKeyArn
```
public final String encryptionKeyArn()
```
    The server-side encryption key that is 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 that is 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.
  - lastRestoreTime
```
public final Instant lastRestoreTime()
```
    The date and time 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 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()
```
    The Amazon Resource Name (ARN) of the parent (composite) recovery point.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the parent (composite) recovery point.
  - compositeMemberIdentifier
```
public final String compositeMemberIdentifier()
```
    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:
    
    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 is a boolean value indicating this is a parent (composite) recovery point.
    
    Returns:
    
    This is a boolean value indicating this is a parent (composite) recovery point.
  - resourceName
```
public final String resourceName()
```
    The non-unique name of the resource that belongs to the specified backup.
    
    Returns:
    
    The non-unique name of the resource that belongs to the specified backup.
  - vaultType
```
public final VaultType vaultType()
```
    The type of vault in which the described recovery point is stored.
    
    If the service returns an enum value that is not available in the current SDK version, vaultType will return VaultType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vaultTypeAsString().
    
    Returns:
    
    The type of vault in which the described recovery point is stored.
    
    See Also:
    
    VaultType
  - vaultTypeAsString
```
public final String vaultTypeAsString()
```
    The type of vault in which the described recovery point is stored.
    
    If the service returns an enum value that is not available in the current SDK version, vaultType will return VaultType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from vaultTypeAsString().
    
    Returns:
    
    The type of vault in which the described recovery point is stored.
    
    See Also:
    
    VaultType
  - indexStatus
```
public final IndexStatus indexStatus()
```
    This is the current status for the backup index associated with the specified recovery point.
    
    Statuses are: PENDING | ACTIVE | FAILED | DELETING
    
    A recovery point with an index that has the status of ACTIVE can be included in a search.
    
    If the service returns an enum value that is not available in the current SDK version, indexStatus will return IndexStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from indexStatusAsString().
    
    Returns:
    
    This is the current status for the backup index associated with the specified recovery point.
    
    Statuses are: PENDING | ACTIVE | FAILED | DELETING
    
    A recovery point with an index that has the status of ACTIVE can be included in a search.
    
    See Also:
    
    IndexStatus
  - indexStatusAsString
```
public final String indexStatusAsString()
```
    This is the current status for the backup index associated with the specified recovery point.
    
    Statuses are: PENDING | ACTIVE | FAILED | DELETING
    
    A recovery point with an index that has the status of ACTIVE can be included in a search.
    
    If the service returns an enum value that is not available in the current SDK version, indexStatus will return IndexStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from indexStatusAsString().
    
    Returns:
    
    This is the current status for the backup index associated with the specified recovery point.
    
    Statuses are: PENDING | ACTIVE | FAILED | DELETING
    
    A recovery point with an index that has the status of ACTIVE can be included in a search.
    
    See Also:
    
    IndexStatus
  - indexStatusMessage
```
public final String indexStatusMessage()
```
    A string in the form of a detailed message explaining the status of a backup index associated with the recovery point.
    
    Returns:
    
    A string in the form of a detailed message explaining the status of a backup index associated with the recovery point.
  - toBuilder
```
public RecoveryPointByBackupVault.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RecoveryPointByBackupVault.Builder,RecoveryPointByBackupVault>
  - builder
```
public static RecoveryPointByBackupVault.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RecoveryPointByBackupVault.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 RecoveryPointByBackupVault

Nested Class Summary

Method Summary

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

lastRestoreTime

parentRecoveryPointArn

compositeMemberIdentifier

isParent

resourceName

vaultType

vaultTypeAsString

indexStatus

indexStatusAsString

indexStatusMessage

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField