BackupPlanInput (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.backup.model.BackupPlanInput

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BackupPlanInput
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

BackupPlanInput()

Constructors
Constructor and Description
`BackupPlanInput()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BackupPlanInput`	`clone()`
`boolean`	`equals(Object obj)`
`List<AdvancedBackupSetting>`	`getAdvancedBackupSettings()` Specifies a list of `BackupOptions` for each resource type.
`String`	`getBackupPlanName()` The display name of a backup plan.
`List<BackupRuleInput>`	`getRules()` An array of `BackupRule` objects, each of which specifies a scheduled task that is used to back up a selection of resources.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdvancedBackupSettings(Collection<AdvancedBackupSetting> advancedBackupSettings)` Specifies a list of `BackupOptions` for each resource type.
`void`	`setBackupPlanName(String backupPlanName)` The display name of a backup plan.
`void`	`setRules(Collection<BackupRuleInput> rules)` An array of `BackupRule` objects, each of which specifies a scheduled task that is used to back up a selection of resources.
`String`	`toString()` Returns a string representation of this object.
`BackupPlanInput`	`withAdvancedBackupSettings(AdvancedBackupSetting... advancedBackupSettings)` Specifies a list of `BackupOptions` for each resource type.
`BackupPlanInput`	`withAdvancedBackupSettings(Collection<AdvancedBackupSetting> advancedBackupSettings)` Specifies a list of `BackupOptions` for each resource type.
`BackupPlanInput`	`withBackupPlanName(String backupPlanName)` The display name of a backup plan.
`BackupPlanInput`	`withRules(BackupRuleInput... rules)` An array of `BackupRule` objects, each of which specifies a scheduled task that is used to back up a selection of resources.
`BackupPlanInput`	`withRules(Collection<BackupRuleInput> rules)` An array of `BackupRule` objects, each of which specifies a scheduled task that is used to back up a selection of resources.

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

- Constructor Detail
  - BackupPlanInput
```
public BackupPlanInput()
```
- Method Detail
  - setBackupPlanName
```
public void setBackupPlanName(String backupPlanName)
```
    The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.
    
    Parameters:
    
    backupPlanName - The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.
  - getBackupPlanName
```
public String getBackupPlanName()
```
    The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.
    
    Returns:
    
    The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.
  - withBackupPlanName
```
public BackupPlanInput withBackupPlanName(String backupPlanName)
```
    The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.
    
    Parameters:
    
    backupPlanName - The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRules
```
public List<BackupRuleInput> getRules()
```
    An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.
    
    Returns:
    
    An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.
  - setRules
```
public void setRules(Collection<BackupRuleInput> rules)
```
    An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.
    
    Parameters:
    
    rules - An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.
  - withRules
```
public BackupPlanInput withRules(BackupRuleInput... rules)
```
    An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.
    
    NOTE: This method appends the values to the existing list (if any). Use setRules(java.util.Collection) or withRules(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    rules - An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRules
```
public BackupPlanInput withRules(Collection<BackupRuleInput> rules)
```
    An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.
    
    Parameters:
    
    rules - An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAdvancedBackupSettings
```
public List<AdvancedBackupSetting> getAdvancedBackupSettings()
```
    Specifies a list of BackupOptions for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
    
    Returns:
    
    Specifies a list of BackupOptions for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
  - setAdvancedBackupSettings
```
public void setAdvancedBackupSettings(Collection<AdvancedBackupSetting> advancedBackupSettings)
```
    Specifies a list of BackupOptions for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
    
    Parameters:
    
    advancedBackupSettings - Specifies a list of BackupOptions for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
  - withAdvancedBackupSettings
```
public BackupPlanInput withAdvancedBackupSettings(AdvancedBackupSetting... advancedBackupSettings)
```
    Specifies a list of BackupOptions for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
    
    NOTE: This method appends the values to the existing list (if any). Use setAdvancedBackupSettings(java.util.Collection) or withAdvancedBackupSettings(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    advancedBackupSettings - Specifies a list of BackupOptions for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAdvancedBackupSettings
```
public BackupPlanInput withAdvancedBackupSettings(Collection<AdvancedBackupSetting> advancedBackupSettings)
```
    Specifies a list of BackupOptions for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
    
    Parameters:
    
    advancedBackupSettings - Specifies a list of BackupOptions for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
    
    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 BackupPlanInput 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.772

Class BackupPlanInput

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BackupPlanInput

Method Detail

setBackupPlanName

getBackupPlanName

withBackupPlanName

getRules

setRules

withRules

withRules

getAdvancedBackupSettings

setAdvancedBackupSettings

withAdvancedBackupSettings

withAdvancedBackupSettings

toString

equals

hashCode

clone

marshall