com.oracle.bmc.recovery.model.ProtectionPolicySummary Maven / Gradle / Ivy
Show all versions of oci-java-sdk-recovery Show documentation
/**
* Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved.
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
*/
package com.oracle.bmc.recovery.model;
/**
* Recovery Service enables policy driven backup storage management.
*
* 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 {@link Builder}. This model
* distinguishes fields that are {@code null} because they are unset from fields that are explicitly
* set to {@code null}. This is done in the setter methods of the {@link Builder}, which maintain a
* set of all explicitly set fields called {@link Builder#__explicitlySet__}. The {@link
* #hashCode()} and {@link #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 {@code null} from unset {@code
* null}).
*/
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20210216")
@com.fasterxml.jackson.databind.annotation.JsonDeserialize(
builder = ProtectionPolicySummary.Builder.class)
@com.fasterxml.jackson.annotation.JsonFilter(
com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel.EXPLICITLY_SET_FILTER_NAME)
public final class ProtectionPolicySummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel {
@Deprecated
@java.beans.ConstructorProperties({
"id",
"displayName",
"compartmentId",
"backupRetentionPeriodInDays",
"isPredefinedPolicy",
"policyLockedDateTime",
"timeCreated",
"timeUpdated",
"lifecycleState",
"lifecycleDetails",
"freeformTags",
"definedTags",
"systemTags"
})
public ProtectionPolicySummary(
String id,
String displayName,
String compartmentId,
Integer backupRetentionPeriodInDays,
Boolean isPredefinedPolicy,
String policyLockedDateTime,
java.util.Date timeCreated,
java.util.Date timeUpdated,
LifecycleState lifecycleState,
String lifecycleDetails,
java.util.Map freeformTags,
java.util.Map> definedTags,
java.util.Map> systemTags) {
super();
this.id = id;
this.displayName = displayName;
this.compartmentId = compartmentId;
this.backupRetentionPeriodInDays = backupRetentionPeriodInDays;
this.isPredefinedPolicy = isPredefinedPolicy;
this.policyLockedDateTime = policyLockedDateTime;
this.timeCreated = timeCreated;
this.timeUpdated = timeUpdated;
this.lifecycleState = lifecycleState;
this.lifecycleDetails = lifecycleDetails;
this.freeformTags = freeformTags;
this.definedTags = definedTags;
this.systemTags = systemTags;
}
@com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder(withPrefix = "")
public static class Builder {
/** The protection policy OCID. */
@com.fasterxml.jackson.annotation.JsonProperty("id")
private String id;
/**
* The protection policy OCID.
*
* @param id the value to set
* @return this builder
*/
public Builder id(String id) {
this.id = id;
this.__explicitlySet__.add("id");
return this;
}
/** A user provided name for the protection policy. */
@com.fasterxml.jackson.annotation.JsonProperty("displayName")
private String displayName;
/**
* A user provided name for the protection policy.
*
* @param displayName the value to set
* @return this builder
*/
public Builder displayName(String displayName) {
this.displayName = displayName;
this.__explicitlySet__.add("displayName");
return this;
}
/** The OCID of the compartment that contains the protection policy. */
@com.fasterxml.jackson.annotation.JsonProperty("compartmentId")
private String compartmentId;
/**
* The OCID of the compartment that contains the protection policy.
*
* @param compartmentId the value to set
* @return this builder
*/
public Builder compartmentId(String compartmentId) {
this.compartmentId = compartmentId;
this.__explicitlySet__.add("compartmentId");
return this;
}
/** The maximum number of days to retain backups for a protected database. */
@com.fasterxml.jackson.annotation.JsonProperty("backupRetentionPeriodInDays")
private Integer backupRetentionPeriodInDays;
/**
* The maximum number of days to retain backups for a protected database.
*
* @param backupRetentionPeriodInDays the value to set
* @return this builder
*/
public Builder backupRetentionPeriodInDays(Integer backupRetentionPeriodInDays) {
this.backupRetentionPeriodInDays = backupRetentionPeriodInDays;
this.__explicitlySet__.add("backupRetentionPeriodInDays");
return this;
}
/**
* Set to TRUE if the policy is Oracle-defined, and FALSE for a user-defined custom policy.
* You can modify only the custom policies.
*/
@com.fasterxml.jackson.annotation.JsonProperty("isPredefinedPolicy")
private Boolean isPredefinedPolicy;
/**
* Set to TRUE if the policy is Oracle-defined, and FALSE for a user-defined custom policy.
* You can modify only the custom policies.
*
* @param isPredefinedPolicy the value to set
* @return this builder
*/
public Builder isPredefinedPolicy(Boolean isPredefinedPolicy) {
this.isPredefinedPolicy = isPredefinedPolicy;
this.__explicitlySet__.add("isPredefinedPolicy");
return this;
}
/**
* 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.
*/
@com.fasterxml.jackson.annotation.JsonProperty("policyLockedDateTime")
private String policyLockedDateTime;
/**
* 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.
*
* @param policyLockedDateTime the value to set
* @return this builder
*/
public Builder policyLockedDateTime(String policyLockedDateTime) {
this.policyLockedDateTime = policyLockedDateTime;
this.__explicitlySet__.add("policyLockedDateTime");
return this;
}
/** The time the Protection Policy was created. An RFC3339 formatted datetime string */
@com.fasterxml.jackson.annotation.JsonProperty("timeCreated")
private java.util.Date timeCreated;
/**
* The time the Protection Policy was created. An RFC3339 formatted datetime string
*
* @param timeCreated the value to set
* @return this builder
*/
public Builder timeCreated(java.util.Date timeCreated) {
this.timeCreated = timeCreated;
this.__explicitlySet__.add("timeCreated");
return this;
}
/** The time the Protection Policy was updated. An RFC3339 formatted datetime string */
@com.fasterxml.jackson.annotation.JsonProperty("timeUpdated")
private java.util.Date timeUpdated;
/**
* The time the Protection Policy was updated. An RFC3339 formatted datetime string
*
* @param timeUpdated the value to set
* @return this builder
*/
public Builder timeUpdated(java.util.Date timeUpdated) {
this.timeUpdated = timeUpdated;
this.__explicitlySet__.add("timeUpdated");
return this;
}
/** The current state of the Protection Policy. */
@com.fasterxml.jackson.annotation.JsonProperty("lifecycleState")
private LifecycleState lifecycleState;
/**
* The current state of the Protection Policy.
*
* @param lifecycleState the value to set
* @return this builder
*/
public Builder lifecycleState(LifecycleState lifecycleState) {
this.lifecycleState = lifecycleState;
this.__explicitlySet__.add("lifecycleState");
return this;
}
/**
* 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.
*/
@com.fasterxml.jackson.annotation.JsonProperty("lifecycleDetails")
private String lifecycleDetails;
/**
* 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.
*
* @param lifecycleDetails the value to set
* @return this builder
*/
public Builder lifecycleDetails(String lifecycleDetails) {
this.lifecycleDetails = lifecycleDetails;
this.__explicitlySet__.add("lifecycleDetails");
return this;
}
/**
* Simple key-value pair that is applied without any predefined name, type or scope. Exists
* for cross-compatibility only. Example: {@code {"bar-key": "value"}}
*/
@com.fasterxml.jackson.annotation.JsonProperty("freeformTags")
private java.util.Map freeformTags;
/**
* Simple key-value pair that is applied without any predefined name, type or scope. Exists
* for cross-compatibility only. Example: {@code {"bar-key": "value"}}
*
* @param freeformTags the value to set
* @return this builder
*/
public Builder freeformTags(java.util.Map freeformTags) {
this.freeformTags = freeformTags;
this.__explicitlySet__.add("freeformTags");
return this;
}
/**
* Defined tags for this resource. Each key is predefined and scoped to a namespace.
* Example: {@code {"foo-namespace": {"bar-key": "value"}}}. For more information, see
* [Resource
* Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
*/
@com.fasterxml.jackson.annotation.JsonProperty("definedTags")
private java.util.Map> definedTags;
/**
* Defined tags for this resource. Each key is predefined and scoped to a namespace.
* Example: {@code {"foo-namespace": {"bar-key": "value"}}}. For more information, see
* [Resource
* Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
*
* @param definedTags the value to set
* @return this builder
*/
public Builder definedTags(
java.util.Map> definedTags) {
this.definedTags = definedTags;
this.__explicitlySet__.add("definedTags");
return this;
}
/**
* Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {@code
* {"orcl-cloud": {"free-tier-retained": "true"}}}. For more information, see [Resource
* Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
*/
@com.fasterxml.jackson.annotation.JsonProperty("systemTags")
private java.util.Map> systemTags;
/**
* Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {@code
* {"orcl-cloud": {"free-tier-retained": "true"}}}. For more information, see [Resource
* Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
*
* @param systemTags the value to set
* @return this builder
*/
public Builder systemTags(java.util.Map> systemTags) {
this.systemTags = systemTags;
this.__explicitlySet__.add("systemTags");
return this;
}
@com.fasterxml.jackson.annotation.JsonIgnore
private final java.util.Set __explicitlySet__ = new java.util.HashSet();
public ProtectionPolicySummary build() {
ProtectionPolicySummary model =
new ProtectionPolicySummary(
this.id,
this.displayName,
this.compartmentId,
this.backupRetentionPeriodInDays,
this.isPredefinedPolicy,
this.policyLockedDateTime,
this.timeCreated,
this.timeUpdated,
this.lifecycleState,
this.lifecycleDetails,
this.freeformTags,
this.definedTags,
this.systemTags);
for (String explicitlySetProperty : this.__explicitlySet__) {
model.markPropertyAsExplicitlySet(explicitlySetProperty);
}
return model;
}
@com.fasterxml.jackson.annotation.JsonIgnore
public Builder copy(ProtectionPolicySummary model) {
if (model.wasPropertyExplicitlySet("id")) {
this.id(model.getId());
}
if (model.wasPropertyExplicitlySet("displayName")) {
this.displayName(model.getDisplayName());
}
if (model.wasPropertyExplicitlySet("compartmentId")) {
this.compartmentId(model.getCompartmentId());
}
if (model.wasPropertyExplicitlySet("backupRetentionPeriodInDays")) {
this.backupRetentionPeriodInDays(model.getBackupRetentionPeriodInDays());
}
if (model.wasPropertyExplicitlySet("isPredefinedPolicy")) {
this.isPredefinedPolicy(model.getIsPredefinedPolicy());
}
if (model.wasPropertyExplicitlySet("policyLockedDateTime")) {
this.policyLockedDateTime(model.getPolicyLockedDateTime());
}
if (model.wasPropertyExplicitlySet("timeCreated")) {
this.timeCreated(model.getTimeCreated());
}
if (model.wasPropertyExplicitlySet("timeUpdated")) {
this.timeUpdated(model.getTimeUpdated());
}
if (model.wasPropertyExplicitlySet("lifecycleState")) {
this.lifecycleState(model.getLifecycleState());
}
if (model.wasPropertyExplicitlySet("lifecycleDetails")) {
this.lifecycleDetails(model.getLifecycleDetails());
}
if (model.wasPropertyExplicitlySet("freeformTags")) {
this.freeformTags(model.getFreeformTags());
}
if (model.wasPropertyExplicitlySet("definedTags")) {
this.definedTags(model.getDefinedTags());
}
if (model.wasPropertyExplicitlySet("systemTags")) {
this.systemTags(model.getSystemTags());
}
return this;
}
}
/** Create a new builder. */
public static Builder builder() {
return new Builder();
}
public Builder toBuilder() {
return new Builder().copy(this);
}
/** The protection policy OCID. */
@com.fasterxml.jackson.annotation.JsonProperty("id")
private final String id;
/**
* The protection policy OCID.
*
* @return the value
*/
public String getId() {
return id;
}
/** A user provided name for the protection policy. */
@com.fasterxml.jackson.annotation.JsonProperty("displayName")
private final String displayName;
/**
* A user provided name for the protection policy.
*
* @return the value
*/
public String getDisplayName() {
return displayName;
}
/** The OCID of the compartment that contains the protection policy. */
@com.fasterxml.jackson.annotation.JsonProperty("compartmentId")
private final String compartmentId;
/**
* The OCID of the compartment that contains the protection policy.
*
* @return the value
*/
public String getCompartmentId() {
return compartmentId;
}
/** The maximum number of days to retain backups for a protected database. */
@com.fasterxml.jackson.annotation.JsonProperty("backupRetentionPeriodInDays")
private final Integer backupRetentionPeriodInDays;
/**
* The maximum number of days to retain backups for a protected database.
*
* @return the value
*/
public Integer getBackupRetentionPeriodInDays() {
return backupRetentionPeriodInDays;
}
/**
* Set to TRUE if the policy is Oracle-defined, and FALSE for a user-defined custom policy. You
* can modify only the custom policies.
*/
@com.fasterxml.jackson.annotation.JsonProperty("isPredefinedPolicy")
private final Boolean isPredefinedPolicy;
/**
* Set to TRUE if the policy is Oracle-defined, and FALSE for a user-defined custom policy. You
* can modify only the custom policies.
*
* @return the value
*/
public Boolean getIsPredefinedPolicy() {
return isPredefinedPolicy;
}
/**
* 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.
*/
@com.fasterxml.jackson.annotation.JsonProperty("policyLockedDateTime")
private final String policyLockedDateTime;
/**
* 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.
*
* @return the value
*/
public String getPolicyLockedDateTime() {
return policyLockedDateTime;
}
/** The time the Protection Policy was created. An RFC3339 formatted datetime string */
@com.fasterxml.jackson.annotation.JsonProperty("timeCreated")
private final java.util.Date timeCreated;
/**
* The time the Protection Policy was created. An RFC3339 formatted datetime string
*
* @return the value
*/
public java.util.Date getTimeCreated() {
return timeCreated;
}
/** The time the Protection Policy was updated. An RFC3339 formatted datetime string */
@com.fasterxml.jackson.annotation.JsonProperty("timeUpdated")
private final java.util.Date timeUpdated;
/**
* The time the Protection Policy was updated. An RFC3339 formatted datetime string
*
* @return the value
*/
public java.util.Date getTimeUpdated() {
return timeUpdated;
}
/** The current state of the Protection Policy. */
@com.fasterxml.jackson.annotation.JsonProperty("lifecycleState")
private final LifecycleState lifecycleState;
/**
* The current state of the Protection Policy.
*
* @return the value
*/
public LifecycleState getLifecycleState() {
return lifecycleState;
}
/**
* 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.
*/
@com.fasterxml.jackson.annotation.JsonProperty("lifecycleDetails")
private final String lifecycleDetails;
/**
* 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.
*
* @return the value
*/
public String getLifecycleDetails() {
return lifecycleDetails;
}
/**
* Simple key-value pair that is applied without any predefined name, type or scope. Exists for
* cross-compatibility only. Example: {@code {"bar-key": "value"}}
*/
@com.fasterxml.jackson.annotation.JsonProperty("freeformTags")
private final java.util.Map freeformTags;
/**
* Simple key-value pair that is applied without any predefined name, type or scope. Exists for
* cross-compatibility only. Example: {@code {"bar-key": "value"}}
*
* @return the value
*/
public java.util.Map getFreeformTags() {
return freeformTags;
}
/**
* Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
* {@code {"foo-namespace": {"bar-key": "value"}}}. For more information, see [Resource
* Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
*/
@com.fasterxml.jackson.annotation.JsonProperty("definedTags")
private final java.util.Map> definedTags;
/**
* Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
* {@code {"foo-namespace": {"bar-key": "value"}}}. For more information, see [Resource
* Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
*
* @return the value
*/
public java.util.Map> getDefinedTags() {
return definedTags;
}
/**
* Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {@code
* {"orcl-cloud": {"free-tier-retained": "true"}}}. For more information, see [Resource
* Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
*/
@com.fasterxml.jackson.annotation.JsonProperty("systemTags")
private final java.util.Map> systemTags;
/**
* Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {@code
* {"orcl-cloud": {"free-tier-retained": "true"}}}. For more information, see [Resource
* Tags](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/resourcetags.htm)
*
* @return the value
*/
public java.util.Map> getSystemTags() {
return systemTags;
}
@Override
public String toString() {
return this.toString(true);
}
/**
* Return a string representation of the object.
*
* @param includeByteArrayContents true to include the full contents of byte arrays
* @return string representation
*/
public String toString(boolean includeByteArrayContents) {
java.lang.StringBuilder sb = new java.lang.StringBuilder();
sb.append("ProtectionPolicySummary(");
sb.append("super=").append(super.toString());
sb.append("id=").append(String.valueOf(this.id));
sb.append(", displayName=").append(String.valueOf(this.displayName));
sb.append(", compartmentId=").append(String.valueOf(this.compartmentId));
sb.append(", backupRetentionPeriodInDays=")
.append(String.valueOf(this.backupRetentionPeriodInDays));
sb.append(", isPredefinedPolicy=").append(String.valueOf(this.isPredefinedPolicy));
sb.append(", policyLockedDateTime=").append(String.valueOf(this.policyLockedDateTime));
sb.append(", timeCreated=").append(String.valueOf(this.timeCreated));
sb.append(", timeUpdated=").append(String.valueOf(this.timeUpdated));
sb.append(", lifecycleState=").append(String.valueOf(this.lifecycleState));
sb.append(", lifecycleDetails=").append(String.valueOf(this.lifecycleDetails));
sb.append(", freeformTags=").append(String.valueOf(this.freeformTags));
sb.append(", definedTags=").append(String.valueOf(this.definedTags));
sb.append(", systemTags=").append(String.valueOf(this.systemTags));
sb.append(")");
return sb.toString();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof ProtectionPolicySummary)) {
return false;
}
ProtectionPolicySummary other = (ProtectionPolicySummary) o;
return java.util.Objects.equals(this.id, other.id)
&& java.util.Objects.equals(this.displayName, other.displayName)
&& java.util.Objects.equals(this.compartmentId, other.compartmentId)
&& java.util.Objects.equals(
this.backupRetentionPeriodInDays, other.backupRetentionPeriodInDays)
&& java.util.Objects.equals(this.isPredefinedPolicy, other.isPredefinedPolicy)
&& java.util.Objects.equals(this.policyLockedDateTime, other.policyLockedDateTime)
&& java.util.Objects.equals(this.timeCreated, other.timeCreated)
&& java.util.Objects.equals(this.timeUpdated, other.timeUpdated)
&& java.util.Objects.equals(this.lifecycleState, other.lifecycleState)
&& java.util.Objects.equals(this.lifecycleDetails, other.lifecycleDetails)
&& java.util.Objects.equals(this.freeformTags, other.freeformTags)
&& java.util.Objects.equals(this.definedTags, other.definedTags)
&& java.util.Objects.equals(this.systemTags, other.systemTags)
&& super.equals(other);
}
@Override
public int hashCode() {
final int PRIME = 59;
int result = 1;
result = (result * PRIME) + (this.id == null ? 43 : this.id.hashCode());
result = (result * PRIME) + (this.displayName == null ? 43 : this.displayName.hashCode());
result =
(result * PRIME)
+ (this.compartmentId == null ? 43 : this.compartmentId.hashCode());
result =
(result * PRIME)
+ (this.backupRetentionPeriodInDays == null
? 43
: this.backupRetentionPeriodInDays.hashCode());
result =
(result * PRIME)
+ (this.isPredefinedPolicy == null
? 43
: this.isPredefinedPolicy.hashCode());
result =
(result * PRIME)
+ (this.policyLockedDateTime == null
? 43
: this.policyLockedDateTime.hashCode());
result = (result * PRIME) + (this.timeCreated == null ? 43 : this.timeCreated.hashCode());
result = (result * PRIME) + (this.timeUpdated == null ? 43 : this.timeUpdated.hashCode());
result =
(result * PRIME)
+ (this.lifecycleState == null ? 43 : this.lifecycleState.hashCode());
result =
(result * PRIME)
+ (this.lifecycleDetails == null ? 43 : this.lifecycleDetails.hashCode());
result = (result * PRIME) + (this.freeformTags == null ? 43 : this.freeformTags.hashCode());
result = (result * PRIME) + (this.definedTags == null ? 43 : this.definedTags.hashCode());
result = (result * PRIME) + (this.systemTags == null ? 43 : this.systemTags.hashCode());
result = (result * PRIME) + super.hashCode();
return result;
}
}