java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.database.model.BackupSummary

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class BackupSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
```
A database backup.
To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

*Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Note: Objects should always be created or deserialized using the BackupSummary.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the BackupSummary.Builder, which maintain a set of all explicitly set fields called BackupSummary.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`BackupSummary.BackupDestinationType`	Type of the backup destination.
`static class`	`BackupSummary.Builder`
`static class`	`BackupSummary.DatabaseEdition`	The Oracle Database edition of the DB system from which the database backup was taken.
`static class`	`BackupSummary.LifecycleState`	The current state of the backup.
`static class`	`BackupSummary.Type`	The type of backup.

Field Summary
- Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors
Constructor	Description
BackupSummary(String id, String compartmentId, String databaseId, String displayName, BackupSummary.Type type, Date timeStarted, Date timeEnded, String lifecycleDetails, String availabilityDomain, BackupSummary.LifecycleState lifecycleState, BackupSummary.DatabaseEdition databaseEdition, Double databaseSizeInGBs, String shape, String version, String kmsKeyId, String kmsKeyVersionId, String vaultId, String keyStoreId, String keyStoreWalletName, List<String> secondaryKmsKeyIds, Integer retentionPeriodInDays, Integer retentionPeriodInYears, Date timeExpiryScheduled, Boolean isUsingOracleManagedKeys, BackupSummary.BackupDestinationType backupDestinationType, EncryptionKeyLocationDetails encryptionKeyLocationDetails)	Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static BackupSummary.Builder`	`builder()`	Create a new builder.
`boolean`	`equals(Object o)`
`String`	`getAvailabilityDomain()`	The name of the availability domain where the database backup is stored.
`BackupSummary.BackupDestinationType`	`getBackupDestinationType()`	Type of the backup destination.
`String`	`getCompartmentId()`	The OCID of the compartment.
`BackupSummary.DatabaseEdition`	`getDatabaseEdition()`	The Oracle Database edition of the DB system from which the database backup was taken.
`String`	`getDatabaseId()`	The OCID of the database.
`Double`	`getDatabaseSizeInGBs()`	The size of the database in gigabytes at the time the backup was taken.
`String`	`getDisplayName()`	The user-friendly name for the backup.
`EncryptionKeyLocationDetails`	`getEncryptionKeyLocationDetails()`
`String`	`getId()`	The OCID of the backup.
`Boolean`	`getIsUsingOracleManagedKeys()`	True if Oracle Managed Keys is required for restore of the backup.
`String`	`getKeyStoreId()`	The OCID of the key store of Oracle Vault.
`String`	`getKeyStoreWalletName()`	The wallet name for Oracle Key Vault.
`String`	`getKmsKeyId()`	The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
`String`	`getKmsKeyVersionId()`	The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
`String`	`getLifecycleDetails()`	Additional information about the current lifecycle state.
`BackupSummary.LifecycleState`	`getLifecycleState()`	The current state of the backup.
`Integer`	`getRetentionPeriodInDays()`	The retention period of the long term backup in days.
`Integer`	`getRetentionPeriodInYears()`	The retention period of the long term backup in years.
`List<String>`	`getSecondaryKmsKeyIds()`	List of OCIDs of the key containers used as the secondary encryption key in database transparent data encryption (TDE) operations.
`String`	`getShape()`	Shape of the backup’s source database.
`Date`	`getTimeEnded()`	The date and time the backup was completed.
`Date`	`getTimeExpiryScheduled()`	Expiration time of the long term database backup.
`Date`	`getTimeStarted()`	The date and time the backup started.
`BackupSummary.Type`	`getType()`	The type of backup.
`String`	`getVaultId()`	The OCID of the Oracle Cloud Infrastructure vault.
`String`	`getVersion()`	Version of the backup’s source database
`int`	`hashCode()`
`BackupSummary.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)`	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BackupSummary

@Deprecated
@ConstructorProperties({"id","compartmentId","databaseId","displayName","type","timeStarted","timeEnded","lifecycleDetails","availabilityDomain","lifecycleState","databaseEdition","databaseSizeInGBs","shape","version","kmsKeyId","kmsKeyVersionId","vaultId","keyStoreId","keyStoreWalletName","secondaryKmsKeyIds","retentionPeriodInDays","retentionPeriodInYears","timeExpiryScheduled","isUsingOracleManagedKeys","backupDestinationType","encryptionKeyLocationDetails"})
public BackupSummary(String id,
                     String compartmentId,
                     String databaseId,
                     String displayName,
                     BackupSummary.Type type,
                     Date timeStarted,
                     Date timeEnded,
                     String lifecycleDetails,
                     String availabilityDomain,
                     BackupSummary.LifecycleState lifecycleState,
                     BackupSummary.DatabaseEdition databaseEdition,
                     Double databaseSizeInGBs,
                     String shape,
                     String version,
                     String kmsKeyId,
                     String kmsKeyVersionId,
                     String vaultId,
                     String keyStoreId,
                     String keyStoreWalletName,
                     List<String> secondaryKmsKeyIds,
                     Integer retentionPeriodInDays,
                     Integer retentionPeriodInYears,
                     Date timeExpiryScheduled,
                     Boolean isUsingOracleManagedKeys,
                     BackupSummary.BackupDestinationType backupDestinationType,
                     EncryptionKeyLocationDetails encryptionKeyLocationDetails)

Deprecated.

Method Detail
- builder
```
public static BackupSummary.Builder builder()
```
  Create a new builder.
- toBuilder
```
public BackupSummary.Builder toBuilder()
```
- getId
```
public String getId()
```
  The OCID of the backup.
  
  Returns:
  
  the value
- getCompartmentId
```
public String getCompartmentId()
```
  The OCID of the compartment.
  
  Returns:
  
  the value
- getDatabaseId
```
public String getDatabaseId()
```
  The OCID of the database.
  
  Returns:
  
  the value
- getDisplayName
```
public String getDisplayName()
```
  The user-friendly name for the backup.
  The name does not have to be unique.
  
  Returns:
  
  the value
- getType
```
public BackupSummary.Type getType()
```
  The type of backup.
  
  Returns:
  
  the value
- getTimeStarted
```
public Date getTimeStarted()
```
  The date and time the backup started.
  
  Returns:
  
  the value
- getTimeEnded
```
public Date getTimeEnded()
```
  The date and time the backup was completed.
  
  Returns:
  
  the value
- getLifecycleDetails
```
public String getLifecycleDetails()
```
  Additional information about the current lifecycle state.
  
  Returns:
  
  the value
- getAvailabilityDomain
```
public String getAvailabilityDomain()
```
  The name of the availability domain where the database backup is stored.
  
  Returns:
  
  the value
- getLifecycleState
```
public BackupSummary.LifecycleState getLifecycleState()
```
  The current state of the backup.
  
  Returns:
  
  the value
- getDatabaseEdition
```
public BackupSummary.DatabaseEdition getDatabaseEdition()
```
  The Oracle Database edition of the DB system from which the database backup was taken.
  
  Returns:
  
  the value
- getDatabaseSizeInGBs
```
public Double getDatabaseSizeInGBs()
```
  The size of the database in gigabytes at the time the backup was taken.
  
  Returns:
  
  the value
- getShape
```
public String getShape()
```
  Shape of the backup’s source database.
  
  Returns:
  
  the value
- getVersion
```
public String getVersion()
```
  Version of the backup’s source database
  
  Returns:
  
  the value
- getKmsKeyId
```
public String getKmsKeyId()
```
  The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
  
  Returns:
  
  the value
- getKmsKeyVersionId
```
public String getKmsKeyVersionId()
```
  The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions.
  If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.
  
  Returns:
  
  the value
- getVaultId
```
public String getVaultId()
```
  The OCID of the Oracle Cloud Infrastructure vault.
  This parameter and secretId are required for Customer Managed Keys.
  
  Returns:
  
  the value
- getKeyStoreId
```
public String getKeyStoreId()
```
  The OCID of the key store of Oracle Vault.
  
  Returns:
  
  the value
- getKeyStoreWalletName
```
public String getKeyStoreWalletName()
```
  The wallet name for Oracle Key Vault.
  
  Returns:
  
  the value
- getSecondaryKmsKeyIds
```
public List<String> getSecondaryKmsKeyIds()
```
  List of OCIDs of the key containers used as the secondary encryption key in database transparent data encryption (TDE) operations.
  
  Returns:
  
  the value
- getRetentionPeriodInDays
```
public Integer getRetentionPeriodInDays()
```
  The retention period of the long term backup in days.
  
  Returns:
  
  the value
- getRetentionPeriodInYears
```
public Integer getRetentionPeriodInYears()
```
  The retention period of the long term backup in years.
  
  Returns:
  
  the value
- getTimeExpiryScheduled
```
public Date getTimeExpiryScheduled()
```
  Expiration time of the long term database backup.
  
  Returns:
  
  the value
- getIsUsingOracleManagedKeys
```
public Boolean getIsUsingOracleManagedKeys()
```
  True if Oracle Managed Keys is required for restore of the backup.
  
  Returns:
  
  the value
- getBackupDestinationType
```
public BackupSummary.BackupDestinationType getBackupDestinationType()
```
  Type of the backup destination.
  
  Returns:
  
  the value
- getEncryptionKeyLocationDetails
```
public EncryptionKeyLocationDetails getEncryptionKeyLocationDetails()
```
- toString
```
public String toString()
```
  Overrides:
  
  toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- toString
```
public String toString(boolean includeByteArrayContents)
```
  Return a string representation of the object.
  
  Parameters:
  
  includeByteArrayContents - true to include the full contents of byte arrays
  
  Returns:
  
  string representation
- equals
```
public boolean equals(Object o)
```
  Overrides:
  
  equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Class BackupSummary

Nested Class Summary

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Methods inherited from class java.lang.Object

Constructor Detail

BackupSummary

Method Detail

builder

toBuilder

getId

getCompartmentId

getDatabaseId

getDisplayName

getType

getTimeStarted

getTimeEnded

getLifecycleDetails

getAvailabilityDomain

getLifecycleState

getDatabaseEdition

getDatabaseSizeInGBs

getShape

getVersion

getKmsKeyId

getKmsKeyVersionId

getVaultId

getKeyStoreId

getKeyStoreWalletName

getSecondaryKmsKeyIds

getRetentionPeriodInDays

getRetentionPeriodInYears

getTimeExpiryScheduled

getIsUsingOracleManagedKeys

getBackupDestinationType

getEncryptionKeyLocationDetails

toString

toString

equals

hashCode