com.oracle.bmc.recovery.model

Class CreateProtectionPolicyDetails.Builder

java.lang.Object

com.oracle.bmc.recovery.model.CreateProtectionPolicyDetails.Builder

Enclosing class:

CreateProtectionPolicyDetails

public static class CreateProtectionPolicyDetails.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CreateProtectionPolicyDetails.Builder	backupRetentionPeriodInDays(Integer backupRetentionPeriodInDays) The maximum number of days to retain backups for a protected database.
CreateProtectionPolicyDetails	build()
CreateProtectionPolicyDetails.Builder	compartmentId(String compartmentId) Compartment Identifier
CreateProtectionPolicyDetails.Builder	copy(CreateProtectionPolicyDetails model)
CreateProtectionPolicyDetails.Builder	definedTags(Map<String,Map<String,Object>> definedTags) Defined tags for this resource.
CreateProtectionPolicyDetails.Builder	displayName(String displayName) A user provided name for the protection policy.
CreateProtectionPolicyDetails.Builder	freeformTags(Map<String,String> freeformTags) Simple key-value pair that is applied without any predefined name, type or scope.
CreateProtectionPolicyDetails.Builder	mustEnforceCloudLocality(Boolean mustEnforceCloudLocality) Indicates whether the protection policy enforces Recovery Service to retain backups in the same cloud service environment where your Oracle Database is provisioned.
CreateProtectionPolicyDetails.Builder	policyLockedDateTime(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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

displayName

public CreateProtectionPolicyDetails.Builder displayName(String displayName)

A user provided name for the protection policy. The ‘displayName’ does not have to be unique, and it can be modified. Avoid entering confidential information.

Parameters:

displayName - the value to set

Returns:

this builder

backupRetentionPeriodInDays

public CreateProtectionPolicyDetails.Builder backupRetentionPeriodInDays(Integer backupRetentionPeriodInDays)

The maximum number of days to retain backups for a protected database.

Parameters:

backupRetentionPeriodInDays - the value to set

Returns:

this builder

compartmentId

public CreateProtectionPolicyDetails.Builder compartmentId(String compartmentId)

Compartment Identifier

Parameters:

compartmentId - the value to set

Returns:

this builder

mustEnforceCloudLocality

public CreateProtectionPolicyDetails.Builder mustEnforceCloudLocality(Boolean mustEnforceCloudLocality)

Indicates whether the protection policy enforces Recovery Service to retain backups in the same cloud service environment where your Oracle Database is provisioned. This parameter is applicable if your Oracle Database runs in a different cloud service environment, such as Microsoft Azure. If you set the mustEnforceCloudLocality parameter to TRUE, then Recovery Service stores the database backups locally in the same cloud service environment where the database resides. For example, if your Oracle Database is provisioned on Microsoft Azure, then Recovery Service stores the database backups in Azure. Note: You cannot change the mustEnforceCloudLocality setting for a protection policy after you create it.

Parameters:

mustEnforceCloudLocality - the value to set

Returns:

this builder

policyLockedDateTime

public CreateProtectionPolicyDetails.Builder policyLockedDateTime(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.

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. Therefore, you must set policyLockedDateTime to a date that occurs 14 days after the current date. * For example, assuming that the current date is Aug 1, 2023 9 pm, you can set policyLockedDateTime to '2023-08-15T21:00:00.600Z' (Aug 15, 2023, 9:00 pm), or greater. * During the 14-day delay period, you can either increase or decrease the retention period in the policy. * However, you are only allowed to increase the retention period on or after the retention lock date. * You cannot change the value of policyLockedDateTime if the retention lock is already in effect.

Parameters:

policyLockedDateTime - the value to set

Returns:

this builder

freeformTags

public CreateProtectionPolicyDetails.Builder freeformTags(Map<String,String> freeformTags)

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Parameters:

freeformTags - the value to set

Returns:

this builder

definedTags

public CreateProtectionPolicyDetails.Builder definedTags(Map<String,Map<String,Object>> definedTags)

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

Parameters:

definedTags - the value to set

Returns:

this builder

build

public CreateProtectionPolicyDetails build()

copy

public CreateProtectionPolicyDetails.Builder copy(CreateProtectionPolicyDetails model)