@Generated(value="OracleSDKGenerator",
comments="API Version: 20210216")
public final class ProtectedDatabaseSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
A protected database is an Oracle Cloud Database whose backups are managed by Oracle Database Autonomous Recovery Service. Each protected database requires a recovery service subnet and a protection policy to use Recovery Service as the backup destination for centralized backup and recovery.
To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
For information about access control and compartments, see [Overview of the Identity
Service](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm).
Note: Objects should always be created or deserialized using the ProtectedDatabaseSummary.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 ProtectedDatabaseSummary.Builder, which maintain a
set of all explicitly set fields called ProtectedDatabaseSummary.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).
| Modifier and Type | Class and Description |
|---|---|
static class |
ProtectedDatabaseSummary.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
ProtectedDatabaseSummary(String id,
String displayName,
String compartmentId,
String dbUniqueName,
String vpcUserName,
DatabaseSizes databaseSize,
String protectionPolicyId,
String policyLockedDateTime,
List<RecoveryServiceSubnetDetails> recoveryServiceSubnets,
String databaseId,
Date timeCreated,
Date timeUpdated,
LifecycleState lifecycleState,
Health health,
String lifecycleDetails,
String healthDetails,
Boolean isReadOnlyResource,
MetricsSummary metrics,
String subscriptionId,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static ProtectedDatabaseSummary.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getCompartmentId()
The OCID of the compartment that contains the protected database.
|
String |
getDatabaseId()
The OCID of the protected database.
|
DatabaseSizes |
getDatabaseSize()
The size of the protected database.
|
String |
getDbUniqueName()
The dbUniqueName for the protected database in Recovery Service.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
The protected database name.
|
Map<String,String> |
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.
|
Health |
getHealth()
The health of the Protected Database.
|
String |
getHealthDetails()
A message describing the current health of the protected database.
|
String |
getId()
The OCID of the protected database.
|
Boolean |
getIsReadOnlyResource()
Indicates whether the protected database is created by Recovery Service or created manually.
|
String |
getLifecycleDetails()
Detailed description about the current lifecycle state of the protected database.
|
LifecycleState |
getLifecycleState()
The current state of the Protected Database.
|
MetricsSummary |
getMetrics() |
String |
getPolicyLockedDateTime()
An RFC3339 formatted datetime string that specifies the exact date and time for the retention
lock to take effect and permanently lock the retention period defined in the policy.
|
String |
getProtectionPolicyId()
The OCID of the protection policy associated with the protected database.
|
List<RecoveryServiceSubnetDetails> |
getRecoveryServiceSubnets()
List of recovery service subnet resources associated with the protected database.
|
String |
getSubscriptionId()
The OCID of the cloud service subscription to which the protected database is linked.
|
Map<String,Map<String,Object>> |
getSystemTags()
Usage of system tag keys.
|
Date |
getTimeCreated()
An RFC3339 formatted datetime string that indicates the created time for a protected
database.
|
Date |
getTimeUpdated()
An RFC3339 formatted datetime string that indicates the last updated time for a protected
database.
|
String |
getVpcUserName()
The virtual private catalog (VPC) user credentials that authenticates the protected database
to access Recovery Service.
|
int |
hashCode() |
ProtectedDatabaseSummary.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","compartmentId","dbUniqueName","vpcUserName","databaseSize","protectionPolicyId","policyLockedDateTime","recoveryServiceSubnets","databaseId","timeCreated","timeUpdated","lifecycleState","health","lifecycleDetails","healthDetails","isReadOnlyResource","metrics","subscriptionId","freeformTags","definedTags","systemTags"}) public ProtectedDatabaseSummary(String id, String displayName, String compartmentId, String dbUniqueName, String vpcUserName, DatabaseSizes databaseSize, String protectionPolicyId, String policyLockedDateTime, List<RecoveryServiceSubnetDetails> recoveryServiceSubnets, String databaseId, Date timeCreated, Date timeUpdated, LifecycleState lifecycleState, Health health, String lifecycleDetails, String healthDetails, Boolean isReadOnlyResource, MetricsSummary metrics, String subscriptionId, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)
public static ProtectedDatabaseSummary.Builder builder()
Create a new builder.
public ProtectedDatabaseSummary.Builder toBuilder()
public String getId()
The OCID of the protected database.
public String getDisplayName()
The protected database name. You can change the displayName. Avoid entering confidential information.
public String getCompartmentId()
The OCID of the compartment that contains the protected database.
public String getDbUniqueName()
The dbUniqueName for the protected database in Recovery Service. You cannot change the unique name.
public String getVpcUserName()
The virtual private catalog (VPC) user credentials that authenticates the protected database to access Recovery Service.
public DatabaseSizes getDatabaseSize()
The size of the protected database. XS - Less than 5GB, S - 5GB to 50GB, M - 50GB to 500GB, L
public String getProtectionPolicyId()
The OCID of the protection policy associated with the protected database.
public String getPolicyLockedDateTime()
An RFC3339 formatted datetime string that specifies the exact date and time for the retention lock to take effect and permanently lock the retention period defined in the policy.
The retention lock feature controls whether Recovery Service strictly preserves backups for the duration defined in a policy. Retention lock is useful to enforce recovery window compliance and to prevent unintentional modifications to protected database backups. Recovery Service enforces a 14-day delay before the retention lock set for a policy can take effect.
public List<RecoveryServiceSubnetDetails> getRecoveryServiceSubnets()
List of recovery service subnet resources associated with the protected database.
public String getDatabaseId()
The OCID of the protected database.
public Date getTimeCreated()
An RFC3339 formatted datetime string that indicates the created time for a protected database. For example: ‘2020-05-22T21:10:29.600Z’
public Date getTimeUpdated()
An RFC3339 formatted datetime string that indicates the last updated time for a protected database. For example: ‘2020-05-22T21:10:29.600Z’
public LifecycleState getLifecycleState()
The current state of the Protected Database.
public Health getHealth()
The health of the Protected Database.
public String getLifecycleDetails()
Detailed description about the current lifecycle state of the protected database. For example, it can be used to provide actionable information for a resource in a Failed state.
public String getHealthDetails()
A message describing the current health of the protected database.
public Boolean getIsReadOnlyResource()
Indicates whether the protected database is created by Recovery Service or created manually. Set to TRUE for a service-defined protected database. When you enable the OCI-managed automatic backups option for a database and set Recovery Service as the backup destination, then Recovery Service creates the associated protected database resource. Set to FALSE for a user-defined protected database.
public MetricsSummary getMetrics()
public String getSubscriptionId()
The OCID of the cloud service subscription to which the protected database is linked.
public Map<String,String> getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope. Exists for
cross-compatibility only. Example: {"bar-key": "value"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace": {"bar-key": "value"}}. For more information, see Resource
Tags
public Map<String,Map<String,Object>> getSystemTags()
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}. For more information, see Resource
Tags
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.