com.amazonaws.services.backup.model

Class BackupPlan

java.lang.Object

com.amazonaws.services.backup.model.BackupPlan

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class BackupPlan
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 and can back up a different selection of Amazon Web Services resources.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
BackupPlan()

Method Summary

Modifier and Type	Method and Description
BackupPlan	clone()
boolean	equals(Object obj)
List<AdvancedBackupSetting>	getAdvancedBackupSettings() Contains a list of BackupOptions for each resource type.
String	getBackupPlanName() The display name of a backup plan.
List<BackupRule>	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) Contains a list of BackupOptions for each resource type.
void	setBackupPlanName(String backupPlanName) The display name of a backup plan.
void	setRules(Collection<BackupRule> 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.
BackupPlan	withAdvancedBackupSettings(AdvancedBackupSetting... advancedBackupSettings) Contains a list of BackupOptions for each resource type.
BackupPlan	withAdvancedBackupSettings(Collection<AdvancedBackupSetting> advancedBackupSettings) Contains a list of BackupOptions for each resource type.
BackupPlan	withBackupPlanName(String backupPlanName) The display name of a backup plan.
BackupPlan	withRules(BackupRule... rules) An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.
BackupPlan	withRules(Collection<BackupRule> 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

BackupPlan

public BackupPlan()

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 BackupPlan 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<BackupRule> 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<BackupRule> 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 BackupPlan withRules(BackupRule... 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 BackupPlan withRules(Collection<BackupRule> 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()

Contains a list of BackupOptions for each resource type.

Returns:

Contains a list of BackupOptions for each resource type.

setAdvancedBackupSettings

public void setAdvancedBackupSettings(Collection<AdvancedBackupSetting> advancedBackupSettings)

Contains a list of BackupOptions for each resource type.

Parameters:

advancedBackupSettings - Contains a list of BackupOptions for each resource type.

withAdvancedBackupSettings

public BackupPlan withAdvancedBackupSettings(AdvancedBackupSetting... advancedBackupSettings)

Contains a list of BackupOptions for each resource type.

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 - Contains a list of BackupOptions for each resource type.

Returns:

Returns a reference to this object so that method calls can be chained together.

withAdvancedBackupSettings

public BackupPlan withAdvancedBackupSettings(Collection<AdvancedBackupSetting> advancedBackupSettings)

Contains a list of BackupOptions for each resource type.

Parameters:

advancedBackupSettings - Contains a list of BackupOptions for each resource type.

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 BackupPlan 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.