ProtectionPolicy (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.recovery.model.ProtectionPolicy

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210216")
public final class ProtectionPolicy
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
```
The details of a protection policy.A policy defines the exact number of days to retain protected database backups created by Recovery Service. Each protected database must be associated with one protection policy. You can use Oracle-defined protection policies or create custom policies to suit your internal backup storage regulation demands.
Note: Objects should always be created or deserialized using the ProtectionPolicy.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 ProtectionPolicy.Builder, which maintain a set of all explicitly set fields called ProtectionPolicy.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 and Description

static class ProtectionPolicy.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`ProtectionPolicy.Builder`

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 and Description
`ProtectionPolicy(String id, String displayName, String compartmentId, Integer backupRetentionPeriodInDays, Boolean isPredefinedPolicy, String policyLockedDateTime, Boolean mustEnforceCloudLocality, Date timeCreated, Date timeUpdated, LifecycleState lifecycleState, String lifecycleDetails, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ProtectionPolicy.Builder`	`builder()` Create a new builder.
`boolean`	`equals(Object o)`
`Integer`	`getBackupRetentionPeriodInDays()` The maximum number of days to retain backups for a protected database.
`String`	`getCompartmentId()` The OCID of the compartment that contains the protection policy.
`Map<String,Map<String,Object>>`	`getDefinedTags()` Defined tags for this resource.
`String`	`getDisplayName()` A user provided name for the protection policy.
`Map<String,String>`	`getFreeformTags()` Simple key-value pair that is applied without any predefined name, type or scope.
`String`	`getId()` The protection policy OCID.
`Boolean`	`getIsPredefinedPolicy()` Set to TRUE if the policy is Oracle-defined, and FALSE for a user-defined custom policy.
`String`	`getLifecycleDetails()` Detailed description about the current lifecycle state of the protection policy.
`LifecycleState`	`getLifecycleState()` The current state of the protection policy.
`Boolean`	`getMustEnforceCloudLocality()` Indicates whether the protection policy enforces Recovery Service to retain backups in the same cloud service environment where your Oracle Database is provisioned.
`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.
`Map<String,Map<String,Object>>`	`getSystemTags()` Usage of system tag keys.
`Date`	`getTimeCreated()` An RFC3339 formatted datetime string that indicates the created time for the protection policy.
`Date`	`getTimeUpdated()` An RFC3339 formatted datetime string that indicates the updated time for the protection policy.
`int`	`hashCode()`
`ProtectionPolicy.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

ProtectionPolicy

@Deprecated
 @ConstructorProperties(value={"id","displayName","compartmentId","backupRetentionPeriodInDays","isPredefinedPolicy","policyLockedDateTime","mustEnforceCloudLocality","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","freeformTags","definedTags","systemTags"})
public ProtectionPolicy(String id,
                                                                                                                                                                                                                                                                                                                       String displayName,
                                                                                                                                                                                                                                                                                                                       String compartmentId,
                                                                                                                                                                                                                                                                                                                       Integer backupRetentionPeriodInDays,
                                                                                                                                                                                                                                                                                                                       Boolean isPredefinedPolicy,
                                                                                                                                                                                                                                                                                                                       String policyLockedDateTime,
                                                                                                                                                                                                                                                                                                                       Boolean mustEnforceCloudLocality,
                                                                                                                                                                                                                                                                                                                       Date timeCreated,
                                                                                                                                                                                                                                                                                                                       Date timeUpdated,
                                                                                                                                                                                                                                                                                                                       LifecycleState lifecycleState,
                                                                                                                                                                                                                                                                                                                       String lifecycleDetails,
                                                                                                                                                                                                                                                                                                                       Map<String,String> freeformTags,
                                                                                                                                                                                                                                                                                                                       Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                                                                                                                                                       Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Detail
- builder
```
public static ProtectionPolicy.Builder builder()
```
  Create a new builder.
- toBuilder
```
public ProtectionPolicy.Builder toBuilder()
```
- getId
```
public String getId()
```
  The protection policy OCID.
  
  Returns:
  
  the value
- getDisplayName
```
public String getDisplayName()
```
  A user provided name for the protection policy.
  
  Returns:
  
  the value
- getCompartmentId
```
public String getCompartmentId()
```
  The OCID of the compartment that contains the protection policy.
  
  Returns:
  
  the value
- getBackupRetentionPeriodInDays
```
public Integer getBackupRetentionPeriodInDays()
```
  The maximum number of days to retain backups for a protected database. Specify a period ranging from a minimum 14 days to a maximum 95 days. For example, specify the value 55 if you want to retain backups for 55 days.
  
  Returns:
  
  the value
- getIsPredefinedPolicy
```
public Boolean getIsPredefinedPolicy()
```
  Set to TRUE if the policy is Oracle-defined, and FALSE for a user-defined custom policy. You can modify only the custom policies.
  
  Returns:
  
  the value
- getPolicyLockedDateTime
```
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.
  
  Returns:
  
  the value
- getMustEnforceCloudLocality
```
public Boolean getMustEnforceCloudLocality()
```
  Indicates whether the protection policy enforces Recovery Service to retain backups in the same cloud service environment where your Oracle Database is provisioned.
  
  Returns:
  
  the value
- getTimeCreated
```
public Date getTimeCreated()
```
  An RFC3339 formatted datetime string that indicates the created time for the protection policy. For example: ‘2020-05-22T21:10:29.600Z’.
  
  Returns:
  
  the value
- getTimeUpdated
```
public Date getTimeUpdated()
```
  An RFC3339 formatted datetime string that indicates the updated time for the protection policy. For example: ‘2020-05-22T21:10:29.600Z’.
  
  Returns:
  
  the value
- getLifecycleState
```
public LifecycleState getLifecycleState()
```
  The current state of the protection policy.
  
  Returns:
  
  the value
- getLifecycleDetails
```
public String getLifecycleDetails()
```
  Detailed description about the current lifecycle state of the protection policy. For example, it can be used to provide actionable information for a resource in a Failed state.
  
  Returns:
  
  the value
- getFreeformTags
```
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"}
  
  Returns:
  
  the value
- getDefinedTags
```
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
  
  Returns:
  
  the value
- getSystemTags
```
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
  
  Returns:
  
  the value
- 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 ProtectionPolicy

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

ProtectionPolicy

Method Detail

builder

toBuilder

getId

getDisplayName

getCompartmentId

getBackupRetentionPeriodInDays

getIsPredefinedPolicy

getPolicyLockedDateTime

getMustEnforceCloudLocality

getTimeCreated

getTimeUpdated

getLifecycleState

getLifecycleDetails

getFreeformTags

getDefinedTags

getSystemTags

toString

toString

equals

hashCode