Package com.ibm.cloud.is.vpc.v1.model

Class CreateBackupPolicyPlanOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.is.vpc.v1.model.CreateBackupPolicyPlanOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class CreateBackupPolicyPlanOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The createBackupPolicyPlan options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateBackupPolicyPlanOptions.Builder	Builder.

Method Summary

Modifier and Type	Method	Description
Boolean	active()	Gets the active.
List<String>	attachUserTags()	Gets the attachUserTags.
String	backupPolicyId()	Gets the backupPolicyId.
BackupPolicyPlanClonePolicyPrototype	clonePolicy()	Gets the clonePolicy.
Boolean	copyUserTags()	Gets the copyUserTags.
String	cronSpec()	Gets the cronSpec.
BackupPolicyPlanDeletionTriggerPrototype	deletionTrigger()	Gets the deletionTrigger.
String	name()	Gets the name.
CreateBackupPolicyPlanOptions.Builder	newBuilder()	New builder.
List<BackupPolicyPlanRemoteRegionPolicyPrototype>	remoteRegionPolicies()	Gets the remoteRegionPolicies.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public CreateBackupPolicyPlanOptions.Builder newBuilder()

New builder.

Returns:

a CreateBackupPolicyPlanOptions builder

backupPolicyId

public String backupPolicyId()

Gets the backupPolicyId. The backup policy identifier.

Returns:

the backupPolicyId

cronSpec

public String cronSpec()

Gets the cronSpec. The cron specification for the backup schedule. The backup policy jobs (which create and delete backups for this plan) will not start until this time, and may start for up to 90 minutes after this time. All backup schedules for plans in the same policy must be at least an hour apart.

Returns:

the cronSpec

active

public Boolean active()

Gets the active. Indicates whether the plan is active.

Returns:

the active

attachUserTags

public List<String> attachUserTags()

Gets the attachUserTags. User tags to attach to each backup (snapshot) created by this plan. If unspecified, no user tags will be attached.

Returns:

the attachUserTags

clonePolicy

public BackupPolicyPlanClonePolicyPrototype clonePolicy()

Gets the clonePolicy.

Returns:

the clonePolicy

copyUserTags

public Boolean copyUserTags()

Gets the copyUserTags. Indicates whether to copy the source's user tags to the created backups (snapshots).

Returns:

the copyUserTags

deletionTrigger

public BackupPolicyPlanDeletionTriggerPrototype deletionTrigger()

Gets the deletionTrigger.

Returns:

the deletionTrigger

name

public String name()

Gets the name. The name for this backup policy plan. The name must not be used by another plan for the backup policy. If unspecified, the name will be a hyphenated list of randomly-selected words.

Returns:

the name

remoteRegionPolicies

public List<BackupPolicyPlanRemoteRegionPolicyPrototype> remoteRegionPolicies()

Gets the remoteRegionPolicies. The policies for additional backups in remote regions.

Returns:

the remoteRegionPolicies