AwsBackupBackupPlanRuleDetails (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.securityhub.model.AwsBackupBackupPlanRuleDetails

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AwsBackupBackupPlanRuleDetails
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides details about an array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AwsBackupBackupPlanRuleDetails()

Constructors
Constructor and Description
`AwsBackupBackupPlanRuleDetails()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AwsBackupBackupPlanRuleDetails`	`clone()`
`boolean`	`equals(Object obj)`
`Long`	`getCompletionWindowMinutes()` A value in minutes after a backup job is successfully started before it must be completed, or it is canceled by Backup.
`List<AwsBackupBackupPlanRuleCopyActionsDetails>`	`getCopyActions()` An array of `CopyAction` objects, each of which contains details of the copy operation.
`Boolean`	`getEnableContinuousBackup()` Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).
`AwsBackupBackupPlanLifecycleDetails`	`getLifecycle()` Defines when a protected resource is transitioned to cold storage and when it expires.
`String`	`getRuleId()` Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
`String`	`getRuleName()` A display name for a backup rule.
`String`	`getScheduleExpression()` A cron expression in UTC specifying when Backup initiates a backup job.
`Long`	`getStartWindowMinutes()` A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.
`String`	`getTargetBackupVault()` The name of a logical container where backups are stored.
`int`	`hashCode()`
`Boolean`	`isEnableContinuousBackup()` Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCompletionWindowMinutes(Long completionWindowMinutes)` A value in minutes after a backup job is successfully started before it must be completed, or it is canceled by Backup.
`void`	`setCopyActions(Collection<AwsBackupBackupPlanRuleCopyActionsDetails> copyActions)` An array of `CopyAction` objects, each of which contains details of the copy operation.
`void`	`setEnableContinuousBackup(Boolean enableContinuousBackup)` Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).
`void`	`setLifecycle(AwsBackupBackupPlanLifecycleDetails lifecycle)` Defines when a protected resource is transitioned to cold storage and when it expires.
`void`	`setRuleId(String ruleId)` Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
`void`	`setRuleName(String ruleName)` A display name for a backup rule.
`void`	`setScheduleExpression(String scheduleExpression)` A cron expression in UTC specifying when Backup initiates a backup job.
`void`	`setStartWindowMinutes(Long startWindowMinutes)` A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.
`void`	`setTargetBackupVault(String targetBackupVault)` The name of a logical container where backups are stored.
`String`	`toString()` Returns a string representation of this object.
`AwsBackupBackupPlanRuleDetails`	`withCompletionWindowMinutes(Long completionWindowMinutes)` A value in minutes after a backup job is successfully started before it must be completed, or it is canceled by Backup.
`AwsBackupBackupPlanRuleDetails`	`withCopyActions(AwsBackupBackupPlanRuleCopyActionsDetails... copyActions)` An array of `CopyAction` objects, each of which contains details of the copy operation.
`AwsBackupBackupPlanRuleDetails`	`withCopyActions(Collection<AwsBackupBackupPlanRuleCopyActionsDetails> copyActions)` An array of `CopyAction` objects, each of which contains details of the copy operation.
`AwsBackupBackupPlanRuleDetails`	`withEnableContinuousBackup(Boolean enableContinuousBackup)` Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).
`AwsBackupBackupPlanRuleDetails`	`withLifecycle(AwsBackupBackupPlanLifecycleDetails lifecycle)` Defines when a protected resource is transitioned to cold storage and when it expires.
`AwsBackupBackupPlanRuleDetails`	`withRuleId(String ruleId)` Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
`AwsBackupBackupPlanRuleDetails`	`withRuleName(String ruleName)` A display name for a backup rule.
`AwsBackupBackupPlanRuleDetails`	`withScheduleExpression(String scheduleExpression)` A cron expression in UTC specifying when Backup initiates a backup job.
`AwsBackupBackupPlanRuleDetails`	`withStartWindowMinutes(Long startWindowMinutes)` A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.
`AwsBackupBackupPlanRuleDetails`	`withTargetBackupVault(String targetBackupVault)` The name of a logical container where backups are stored.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AwsBackupBackupPlanRuleDetails
```
public AwsBackupBackupPlanRuleDetails()
```
- Method Detail
  - setTargetBackupVault
```
public void setTargetBackupVault(String targetBackupVault)
```
    The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.
    
    Parameters:
    
    targetBackupVault - The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.
  - getTargetBackupVault
```
public String getTargetBackupVault()
```
    The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.
    
    Returns:
    
    The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.
  - withTargetBackupVault
```
public AwsBackupBackupPlanRuleDetails withTargetBackupVault(String targetBackupVault)
```
    The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.
    
    Parameters:
    
    targetBackupVault - The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartWindowMinutes
```
public void setStartWindowMinutes(Long startWindowMinutes)
```
    A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.
    
    Parameters:
    
    startWindowMinutes - A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.
  - getStartWindowMinutes
```
public Long getStartWindowMinutes()
```
    A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.
    
    Returns:
    
    A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.
  - withStartWindowMinutes
```
public AwsBackupBackupPlanRuleDetails withStartWindowMinutes(Long startWindowMinutes)
```
    A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.
    
    Parameters:
    
    startWindowMinutes - A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScheduleExpression
```
public void setScheduleExpression(String scheduleExpression)
```
    A cron expression in UTC specifying when Backup initiates a backup job.
    
    Parameters:
    
    scheduleExpression - A cron expression in UTC specifying when Backup initiates a backup job.
  - getScheduleExpression
```
public String getScheduleExpression()
```
    A cron expression in UTC specifying when Backup initiates a backup job.
    
    Returns:
    
    A cron expression in UTC specifying when Backup initiates a backup job.
  - withScheduleExpression
```
public AwsBackupBackupPlanRuleDetails withScheduleExpression(String scheduleExpression)
```
    A cron expression in UTC specifying when Backup initiates a backup job.
    
    Parameters:
    
    scheduleExpression - A cron expression in UTC specifying when Backup initiates a backup job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRuleName
```
public void setRuleName(String ruleName)
```
    A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
    
    Parameters:
    
    ruleName - A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
  - getRuleName
```
public String getRuleName()
```
    A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
    
    Returns:
    
    A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
  - withRuleName
```
public AwsBackupBackupPlanRuleDetails withRuleName(String ruleName)
```
    A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
    
    Parameters:
    
    ruleName - A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRuleId
```
public void setRuleId(String ruleId)
```
    Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
    
    Parameters:
    
    ruleId - Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
  - getRuleId
```
public String getRuleId()
```
    Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
    
    Returns:
    
    Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
  - withRuleId
```
public AwsBackupBackupPlanRuleDetails withRuleId(String ruleId)
```
    Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
    
    Parameters:
    
    ruleId - Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnableContinuousBackup
```
public void setEnableContinuousBackup(Boolean enableContinuousBackup)
```
    Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).
    
    Parameters:
    
    enableContinuousBackup - Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).
  - getEnableContinuousBackup
```
public Boolean getEnableContinuousBackup()
```
    Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).
    
    Returns:
    
    Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).
  - withEnableContinuousBackup
```
public AwsBackupBackupPlanRuleDetails withEnableContinuousBackup(Boolean enableContinuousBackup)
```
    Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).
    
    Parameters:
    
    enableContinuousBackup - Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnableContinuousBackup
```
public Boolean isEnableContinuousBackup()
```
    Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).
    
    Returns:
    
    Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).
  - setCompletionWindowMinutes
```
public void setCompletionWindowMinutes(Long completionWindowMinutes)
```
    A value in minutes after a backup job is successfully started before it must be completed, or it is canceled by Backup.
    
    Parameters:
    
    completionWindowMinutes - A value in minutes after a backup job is successfully started before it must be completed, or it is canceled by Backup.
  - getCompletionWindowMinutes
```
public Long getCompletionWindowMinutes()
```
    A value in minutes after a backup job is successfully started before it must be completed, or it is canceled by Backup.
    
    Returns:
    
    A value in minutes after a backup job is successfully started before it must be completed, or it is canceled by Backup.
  - withCompletionWindowMinutes
```
public AwsBackupBackupPlanRuleDetails withCompletionWindowMinutes(Long completionWindowMinutes)
```
    A value in minutes after a backup job is successfully started before it must be completed, or it is canceled by Backup.
    
    Parameters:
    
    completionWindowMinutes - A value in minutes after a backup job is successfully started before it must be completed, or it is canceled by Backup.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCopyActions
```
public List<AwsBackupBackupPlanRuleCopyActionsDetails> getCopyActions()
```
    An array of CopyAction objects, each of which contains details of the copy operation.
    
    Returns:
    
    An array of CopyAction objects, each of which contains details of the copy operation.
  - setCopyActions
```
public void setCopyActions(Collection<AwsBackupBackupPlanRuleCopyActionsDetails> copyActions)
```
    An array of CopyAction objects, each of which contains details of the copy operation.
    
    Parameters:
    
    copyActions - An array of CopyAction objects, each of which contains details of the copy operation.
  - withCopyActions
```
public AwsBackupBackupPlanRuleDetails withCopyActions(AwsBackupBackupPlanRuleCopyActionsDetails... copyActions)
```
    An array of CopyAction objects, each of which contains details of the copy operation.
    
    NOTE: This method appends the values to the existing list (if any). Use setCopyActions(java.util.Collection) or withCopyActions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    copyActions - An array of CopyAction objects, each of which contains details of the copy operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCopyActions
```
public AwsBackupBackupPlanRuleDetails withCopyActions(Collection<AwsBackupBackupPlanRuleCopyActionsDetails> copyActions)
```
    An array of CopyAction objects, each of which contains details of the copy operation.
    
    Parameters:
    
    copyActions - An array of CopyAction objects, each of which contains details of the copy operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLifecycle
```
public void setLifecycle(AwsBackupBackupPlanLifecycleDetails lifecycle)
```
    Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.
    
    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.
    
    Parameters:
    
    lifecycle - Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.
    
    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.
  - getLifecycle
```
public AwsBackupBackupPlanLifecycleDetails getLifecycle()
```
    Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.
    
    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.
    
    Returns:
    
    Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.
    
    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.
  - withLifecycle
```
public AwsBackupBackupPlanRuleDetails withLifecycle(AwsBackupBackupPlanLifecycleDetails lifecycle)
```
    Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.
    
    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.
    
    Parameters:
    
    lifecycle - Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.
    
    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AwsBackupBackupPlanRuleDetails clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class AwsBackupBackupPlanRuleDetails

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AwsBackupBackupPlanRuleDetails

Method Detail

setTargetBackupVault

getTargetBackupVault

withTargetBackupVault

setStartWindowMinutes

getStartWindowMinutes

withStartWindowMinutes

setScheduleExpression

getScheduleExpression

withScheduleExpression

setRuleName

getRuleName

withRuleName

setRuleId

getRuleId

withRuleId

setEnableContinuousBackup

getEnableContinuousBackup

withEnableContinuousBackup

isEnableContinuousBackup

setCompletionWindowMinutes

getCompletionWindowMinutes

withCompletionWindowMinutes

getCopyActions

setCopyActions

withCopyActions

withCopyActions

setLifecycle

getLifecycle

withLifecycle

toString

equals

hashCode

clone

marshall