Schedule (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.dlm.model.Schedule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Schedule
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies a backup schedule for a snapshot or AMI lifecycle policy.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Schedule()

Constructors
Constructor and Description
`Schedule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Schedule`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getCopyTags()` Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
`CreateRule`	`getCreateRule()` The creation rule.
`List<CrossRegionCopyRule>`	`getCrossRegionCopyRules()` The rule for cross-Region snapshot copies.
`DeprecateRule`	`getDeprecateRule()` The AMI deprecation rule for the schedule.
`FastRestoreRule`	`getFastRestoreRule()` The rule for enabling fast snapshot restore.
`String`	`getName()` The name of the schedule.
`RetainRule`	`getRetainRule()` The retention rule.
`List<ShareRule>`	`getShareRules()` The rule for sharing snapshots with other Amazon Web Services accounts.
`List<Tag>`	`getTagsToAdd()` The tags to apply to policy-created resources.
`List<Tag>`	`getVariableTags()` A collection of key/value pairs with values determined dynamically when the policy is executed.
`int`	`hashCode()`
`Boolean`	`isCopyTags()` Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCopyTags(Boolean copyTags)` Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
`void`	`setCreateRule(CreateRule createRule)` The creation rule.
`void`	`setCrossRegionCopyRules(Collection<CrossRegionCopyRule> crossRegionCopyRules)` The rule for cross-Region snapshot copies.
`void`	`setDeprecateRule(DeprecateRule deprecateRule)` The AMI deprecation rule for the schedule.
`void`	`setFastRestoreRule(FastRestoreRule fastRestoreRule)` The rule for enabling fast snapshot restore.
`void`	`setName(String name)` The name of the schedule.
`void`	`setRetainRule(RetainRule retainRule)` The retention rule.
`void`	`setShareRules(Collection<ShareRule> shareRules)` The rule for sharing snapshots with other Amazon Web Services accounts.
`void`	`setTagsToAdd(Collection<Tag> tagsToAdd)` The tags to apply to policy-created resources.
`void`	`setVariableTags(Collection<Tag> variableTags)` A collection of key/value pairs with values determined dynamically when the policy is executed.
`String`	`toString()` Returns a string representation of this object.
`Schedule`	`withCopyTags(Boolean copyTags)` Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
`Schedule`	`withCreateRule(CreateRule createRule)` The creation rule.
`Schedule`	`withCrossRegionCopyRules(Collection<CrossRegionCopyRule> crossRegionCopyRules)` The rule for cross-Region snapshot copies.
`Schedule`	`withCrossRegionCopyRules(CrossRegionCopyRule... crossRegionCopyRules)` The rule for cross-Region snapshot copies.
`Schedule`	`withDeprecateRule(DeprecateRule deprecateRule)` The AMI deprecation rule for the schedule.
`Schedule`	`withFastRestoreRule(FastRestoreRule fastRestoreRule)` The rule for enabling fast snapshot restore.
`Schedule`	`withName(String name)` The name of the schedule.
`Schedule`	`withRetainRule(RetainRule retainRule)` The retention rule.
`Schedule`	`withShareRules(Collection<ShareRule> shareRules)` The rule for sharing snapshots with other Amazon Web Services accounts.
`Schedule`	`withShareRules(ShareRule... shareRules)` The rule for sharing snapshots with other Amazon Web Services accounts.
`Schedule`	`withTagsToAdd(Collection<Tag> tagsToAdd)` The tags to apply to policy-created resources.
`Schedule`	`withTagsToAdd(Tag... tagsToAdd)` The tags to apply to policy-created resources.
`Schedule`	`withVariableTags(Collection<Tag> variableTags)` A collection of key/value pairs with values determined dynamically when the policy is executed.
`Schedule`	`withVariableTags(Tag... variableTags)` A collection of key/value pairs with values determined dynamically when the policy is executed.

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

- Constructor Detail
  - Schedule
```
public Schedule()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the schedule.
    
    Parameters:
    
    name - The name of the schedule.
  - getName
```
public String getName()
```
    The name of the schedule.
    
    Returns:
    
    The name of the schedule.
  - withName
```
public Schedule withName(String name)
```
    The name of the schedule.
    
    Parameters:
    
    name - The name of the schedule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCopyTags
```
public void setCopyTags(Boolean copyTags)
```
    Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
    
    Parameters:
    
    copyTags - Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
  - getCopyTags
```
public Boolean getCopyTags()
```
    Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
    
    Returns:
    
    Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
  - withCopyTags
```
public Schedule withCopyTags(Boolean copyTags)
```
    Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
    
    Parameters:
    
    copyTags - Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isCopyTags
```
public Boolean isCopyTags()
```
    Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
    
    Returns:
    
    Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
  - getTagsToAdd
```
public List<Tag> getTagsToAdd()
```
    The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.
    
    Returns:
    
    The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.
  - setTagsToAdd
```
public void setTagsToAdd(Collection<Tag> tagsToAdd)
```
    The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.
    
    Parameters:
    
    tagsToAdd - The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.
  - withTagsToAdd
```
public Schedule withTagsToAdd(Tag... tagsToAdd)
```
    The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.
    
    NOTE: This method appends the values to the existing list (if any). Use setTagsToAdd(java.util.Collection) or withTagsToAdd(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tagsToAdd - The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTagsToAdd
```
public Schedule withTagsToAdd(Collection<Tag> tagsToAdd)
```
    The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.
    
    Parameters:
    
    tagsToAdd - The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getVariableTags
```
public List<Tag> getVariableTags()
```
    A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp). Variable tags are only valid for EBS Snapshot Management – Instance policies.
    
    Returns:
    
    A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp). Variable tags are only valid for EBS Snapshot Management – Instance policies.
  - setVariableTags
```
public void setVariableTags(Collection<Tag> variableTags)
```
    A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp). Variable tags are only valid for EBS Snapshot Management – Instance policies.
    
    Parameters:
    
    variableTags - A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp). Variable tags are only valid for EBS Snapshot Management – Instance policies.
  - withVariableTags
```
public Schedule withVariableTags(Tag... variableTags)
```
    A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp). Variable tags are only valid for EBS Snapshot Management – Instance policies.
    
    NOTE: This method appends the values to the existing list (if any). Use setVariableTags(java.util.Collection) or withVariableTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    variableTags - A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp). Variable tags are only valid for EBS Snapshot Management – Instance policies.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withVariableTags
```
public Schedule withVariableTags(Collection<Tag> variableTags)
```
    A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp). Variable tags are only valid for EBS Snapshot Management – Instance policies.
    
    Parameters:
    
    variableTags - A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp). Variable tags are only valid for EBS Snapshot Management – Instance policies.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreateRule
```
public void setCreateRule(CreateRule createRule)
```
    The creation rule.
    
    Parameters:
    
    createRule - The creation rule.
  - getCreateRule
```
public CreateRule getCreateRule()
```
    The creation rule.
    
    Returns:
    
    The creation rule.
  - withCreateRule
```
public Schedule withCreateRule(CreateRule createRule)
```
    The creation rule.
    
    Parameters:
    
    createRule - The creation rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRetainRule
```
public void setRetainRule(RetainRule retainRule)
```
    The retention rule.
    
    Parameters:
    
    retainRule - The retention rule.
  - getRetainRule
```
public RetainRule getRetainRule()
```
    The retention rule.
    
    Returns:
    
    The retention rule.
  - withRetainRule
```
public Schedule withRetainRule(RetainRule retainRule)
```
    The retention rule.
    
    Parameters:
    
    retainRule - The retention rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFastRestoreRule
```
public void setFastRestoreRule(FastRestoreRule fastRestoreRule)
```
    The rule for enabling fast snapshot restore.
    
    Parameters:
    
    fastRestoreRule - The rule for enabling fast snapshot restore.
  - getFastRestoreRule
```
public FastRestoreRule getFastRestoreRule()
```
    The rule for enabling fast snapshot restore.
    
    Returns:
    
    The rule for enabling fast snapshot restore.
  - withFastRestoreRule
```
public Schedule withFastRestoreRule(FastRestoreRule fastRestoreRule)
```
    The rule for enabling fast snapshot restore.
    
    Parameters:
    
    fastRestoreRule - The rule for enabling fast snapshot restore.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCrossRegionCopyRules
```
public List<CrossRegionCopyRule> getCrossRegionCopyRules()
```
    The rule for cross-Region snapshot copies.
    
    You can only specify cross-Region copy rules for policies that create snapshots in a Region. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.
    
    Returns:
    
    The rule for cross-Region snapshot copies.
    
    You can only specify cross-Region copy rules for policies that create snapshots in a Region. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.
  - setCrossRegionCopyRules
```
public void setCrossRegionCopyRules(Collection<CrossRegionCopyRule> crossRegionCopyRules)
```
    The rule for cross-Region snapshot copies.
    
    You can only specify cross-Region copy rules for policies that create snapshots in a Region. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.
    
    Parameters:
    
    crossRegionCopyRules - The rule for cross-Region snapshot copies.
    
    You can only specify cross-Region copy rules for policies that create snapshots in a Region. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.
  - withCrossRegionCopyRules
```
public Schedule withCrossRegionCopyRules(CrossRegionCopyRule... crossRegionCopyRules)
```
    The rule for cross-Region snapshot copies.
    
    You can only specify cross-Region copy rules for policies that create snapshots in a Region. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.
    
    NOTE: This method appends the values to the existing list (if any). Use setCrossRegionCopyRules(java.util.Collection) or withCrossRegionCopyRules(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    crossRegionCopyRules - The rule for cross-Region snapshot copies.
    
    You can only specify cross-Region copy rules for policies that create snapshots in a Region. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCrossRegionCopyRules
```
public Schedule withCrossRegionCopyRules(Collection<CrossRegionCopyRule> crossRegionCopyRules)
```
    The rule for cross-Region snapshot copies.
    
    You can only specify cross-Region copy rules for policies that create snapshots in a Region. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.
    
    Parameters:
    
    crossRegionCopyRules - The rule for cross-Region snapshot copies.
    
    You can only specify cross-Region copy rules for policies that create snapshots in a Region. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getShareRules
```
public List<ShareRule> getShareRules()
```
    The rule for sharing snapshots with other Amazon Web Services accounts.
    
    Returns:
    
    The rule for sharing snapshots with other Amazon Web Services accounts.
  - setShareRules
```
public void setShareRules(Collection<ShareRule> shareRules)
```
    The rule for sharing snapshots with other Amazon Web Services accounts.
    
    Parameters:
    
    shareRules - The rule for sharing snapshots with other Amazon Web Services accounts.
  - withShareRules
```
public Schedule withShareRules(ShareRule... shareRules)
```
    The rule for sharing snapshots with other Amazon Web Services accounts.
    
    NOTE: This method appends the values to the existing list (if any). Use setShareRules(java.util.Collection) or withShareRules(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    shareRules - The rule for sharing snapshots with other Amazon Web Services accounts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withShareRules
```
public Schedule withShareRules(Collection<ShareRule> shareRules)
```
    The rule for sharing snapshots with other Amazon Web Services accounts.
    
    Parameters:
    
    shareRules - The rule for sharing snapshots with other Amazon Web Services accounts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeprecateRule
```
public void setDeprecateRule(DeprecateRule deprecateRule)
```
    The AMI deprecation rule for the schedule.
    
    Parameters:
    
    deprecateRule - The AMI deprecation rule for the schedule.
  - getDeprecateRule
```
public DeprecateRule getDeprecateRule()
```
    The AMI deprecation rule for the schedule.
    
    Returns:
    
    The AMI deprecation rule for the schedule.
  - withDeprecateRule
```
public Schedule withDeprecateRule(DeprecateRule deprecateRule)
```
    The AMI deprecation rule for the schedule.
    
    Parameters:
    
    deprecateRule - The AMI deprecation rule for the schedule.
    
    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 Schedule 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.

Did this page help you?

Class Schedule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Schedule

Method Detail

setName

getName

withName

setCopyTags

getCopyTags

withCopyTags

isCopyTags

getTagsToAdd

setTagsToAdd

withTagsToAdd

withTagsToAdd

getVariableTags

setVariableTags

withVariableTags

withVariableTags

setCreateRule

getCreateRule

withCreateRule

setRetainRule

getRetainRule

withRetainRule

setFastRestoreRule

getFastRestoreRule

withFastRestoreRule

getCrossRegionCopyRules

setCrossRegionCopyRules

withCrossRegionCopyRules

withCrossRegionCopyRules

getShareRules

setShareRules

withShareRules

withShareRules

setDeprecateRule

getDeprecateRule

withDeprecateRule

toString

equals

hashCode

clone

marshall