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.DescribeBackupVaultResponse

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeBackupVaultResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`backupVaultArn()`	An Amazon Resource Name (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 DescribeBackupVaultResponse.Builder`	`builder()`
`Instant`	`creationDate()`	The date and time that a backup vault is created, in Unix format and Coordinated Universal Time (UTC).
`String`	`creatorRequestId()`	A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
`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()`
`Instant`	`lockDate()`	The date and time when Backup Vault Lock configuration cannot be changed or deleted.
`Boolean`	`locked()`	A Boolean that indicates whether Backup Vault Lock is currently protecting the backup vault.
`Long`	`maxRetentionDays()`	The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points.
`Long`	`minRetentionDays()`	The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points.
`Long`	`numberOfRecoveryPoints()`	The number of recovery points that are stored in a backup vault.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeBackupVaultResponse.Builder>`	`serializableBuilderClass()`
`DescribeBackupVaultResponse.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`VaultType`	`vaultType()`	This is the type of vault described.
`String`	`vaultTypeAsString()`	This is the type of vault described.

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
  - 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 Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
    
    Returns:
    
    An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
  - vaultType
```
public final VaultType vaultType()
```
    This is the type of vault described.
    
    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:
    
    This is the type of vault described.
    
    See Also:
    
    VaultType
  - vaultTypeAsString
```
public final String vaultTypeAsString()
```
    This is the type of vault described.
    
    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:
    
    This is the type of vault described.
    
    See Also:
    
    VaultType
  - 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.
  - creationDate
```
public final Instant creationDate()
```
    The date and time that a backup vault 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 backup vault 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.
  - creatorRequestId
```
public final String creatorRequestId()
```
    A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
    
    Returns:
    
    A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
  - numberOfRecoveryPoints
```
public final Long numberOfRecoveryPoints()
```
    The number of recovery points that are stored in a backup vault.
    
    Returns:
    
    The number of recovery points that are stored in a backup vault.
  - locked
```
public final Boolean locked()
```
    A Boolean that indicates whether Backup Vault Lock is currently protecting the backup vault. True means that Vault Lock causes delete or update operations on the recovery points stored in the vault to fail.
    
    Returns:
    
    A Boolean that indicates whether Backup Vault Lock is currently protecting the backup vault. True means that Vault Lock causes delete or update operations on the recovery points stored in the vault to fail.
  - minRetentionDays
```
public final Long minRetentionDays()
```
    The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a minimum retention period.
    
    If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
    
    Returns:
    
    The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a minimum retention period.
    
    If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
  - maxRetentionDays
```
public final Long maxRetentionDays()
```
    The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).
    
    If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
    
    Returns:
    
    The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).
    
    If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.
  - lockDate
```
public final Instant lockDate()
```
    The date and time when Backup Vault Lock configuration cannot be changed or deleted.
    
    If you applied Vault Lock to your vault without specifying a lock date, you can change any of your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.
    
    This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    
    Returns:
    
    The date and time when Backup Vault Lock configuration cannot be changed or deleted.
    
    If you applied Vault Lock to your vault without specifying a lock date, you can change any of your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.
    
    This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
  - toBuilder
```
public DescribeBackupVaultResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeBackupVaultResponse.Builder,DescribeBackupVaultResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeBackupVaultResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeBackupVaultResponse.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 DescribeBackupVaultResponse

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

backupVaultName

backupVaultArn

vaultType

vaultTypeAsString

encryptionKeyArn

creationDate

creatorRequestId

numberOfRecoveryPoints

locked

minRetentionDays

maxRetentionDays

lockDate

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields