Package com.ibm.cloud.is.vpc.v1.model
Class BackupPolicy
- java.lang.Object
-
- com.ibm.cloud.sdk.core.service.model.GenericModel
-
- com.ibm.cloud.is.vpc.v1.model.BackupPolicy
-
- All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
- Direct Known Subclasses:
BackupPolicyMatchResourceTypeInstance,BackupPolicyMatchResourceTypeVolume
public class BackupPolicy extends com.ibm.cloud.sdk.core.service.model.GenericModelBackupPolicy. Classes which extend this class: - BackupPolicyMatchResourceTypeInstance - BackupPolicyMatchResourceTypeVolume
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceBackupPolicy.HealthStateThe health of this resource.static interfaceBackupPolicy.IncludedContentAn item to include.static interfaceBackupPolicy.LifecycleStateThe lifecycle state of the backup policy.static interfaceBackupPolicy.MatchResourceTypeThe resource type this backup policy applies to.static interfaceBackupPolicy.ResourceTypeThe resource type.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DategetCreatedAt()Gets the createdAt.StringgetCrn()Gets the crn.List<BackupPolicyHealthReason>getHealthReasons()Gets the healthReasons.StringgetHealthState()Gets the healthState.StringgetHref()Gets the href.StringgetId()Gets the id.List<String>getIncludedContent()Gets the includedContent.DategetLastJobCompletedAt()Gets the lastJobCompletedAt.StringgetLifecycleState()Gets the lifecycleState.StringgetMatchResourceType()Gets the matchResourceType.List<String>getMatchUserTags()Gets the matchUserTags.StringgetName()Gets the name.List<BackupPolicyPlanReference>getPlans()Gets the plans.ResourceGroupReferencegetResourceGroup()Gets the resourceGroup.StringgetResourceType()Gets the resourceType.BackupPolicyScopegetScope()Gets the scope.
-
-
-
Method Detail
-
getCreatedAt
public Date getCreatedAt()
Gets the createdAt. The date and time that the backup policy was created.- Returns:
- the createdAt
-
getCrn
public String getCrn()
Gets the crn. The CRN for this backup policy.- Returns:
- the crn
-
getHealthReasons
public List<BackupPolicyHealthReason> getHealthReasons()
Gets the healthReasons. The reasons for the current `health_state` (if any). The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.- Returns:
- the healthReasons
-
getHealthState
public String getHealthState()
Gets the healthState. The health of this resource. - `ok`: No abnormal behavior detected - `degraded`: Experiencing compromised performance, capacity, or connectivity - `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated - `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also have this state.- Returns:
- the healthState
-
getHref
public String getHref()
Gets the href. The URL for this backup policy.- Returns:
- the href
-
getId
public String getId()
Gets the id. The unique identifier for this backup policy.- Returns:
- the id
-
getLastJobCompletedAt
public Date getLastJobCompletedAt()
Gets the lastJobCompletedAt. The date and time that the most recent job for this backup policy completed. If absent, no job has yet completed for this backup policy.- Returns:
- the lastJobCompletedAt
-
getLifecycleState
public String getLifecycleState()
Gets the lifecycleState. The lifecycle state of the backup policy.- Returns:
- the lifecycleState
-
getMatchResourceType
public String getMatchResourceType()
Gets the matchResourceType. The resource type this backup policy applies to. Resources that have both a matching type and a matching user tag will be subject to the backup policy. The enumerated values for this property may expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.- Returns:
- the matchResourceType
-
getMatchUserTags
public List<String> getMatchUserTags()
Gets the matchUserTags. The user tags this backup policy applies to. Resources that have both a matching user tag and a matching type will be subject to the backup policy.- Returns:
- the matchUserTags
-
getName
public String getName()
Gets the name. The name for this backup policy. The name is unique across all backup policies in the region.- Returns:
- the name
-
getPlans
public List<BackupPolicyPlanReference> getPlans()
Gets the plans. The plans for the backup policy.- Returns:
- the plans
-
getResourceGroup
public ResourceGroupReference getResourceGroup()
Gets the resourceGroup. The resource group for this backup policy.- Returns:
- the resourceGroup
-
getResourceType
public String getResourceType()
Gets the resourceType. The resource type.- Returns:
- the resourceType
-
getScope
public BackupPolicyScope getScope()
Gets the scope. The scope for this backup policy.- Returns:
- the scope
-
getIncludedContent
public List<String> getIncludedContent()
Gets the includedContent. The included content for backups created using this policy: - `boot_volume`: Include the instance's boot volume. - `data_volumes`: Include the instance's data volumes. The enumerated values for this property may expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the backup policy on which the unexpected property value was encountered.- Returns:
- the includedContent
-
-