Schedule (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.dlm.model.Schedule

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Schedule.Builder,Schedule>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Schedule
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Schedule.Builder,Schedule>
```
Specifies a backup schedule for a snapshot or AMI lifecycle policy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Schedule.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Schedule.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Schedule.Builder`	`builder()`
`Boolean`	`copyTags()` Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
`CreateRule`	`createRule()` The creation rule.
`List<CrossRegionCopyRule>`	`crossRegionCopyRules()` The rule for cross-Region snapshot copies.
`DeprecateRule`	`deprecateRule()` The AMI deprecation rule for the schedule.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`FastRestoreRule`	`fastRestoreRule()` The rule for enabling fast snapshot restore.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCrossRegionCopyRules()` For responses, this returns true if the service returned a value for the CrossRegionCopyRules property.
`int`	`hashCode()`
`boolean`	`hasShareRules()` For responses, this returns true if the service returned a value for the ShareRules property.
`boolean`	`hasTagsToAdd()` For responses, this returns true if the service returned a value for the TagsToAdd property.
`boolean`	`hasVariableTags()` For responses, this returns true if the service returned a value for the VariableTags property.
`String`	`name()` The name of the schedule.
`RetainRule`	`retainRule()` The retention rule.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Schedule.Builder>`	`serializableBuilderClass()`
`List<ShareRule>`	`shareRules()` The rule for sharing snapshots with other Amazon Web Services accounts.
`List<Tag>`	`tagsToAdd()` The tags to apply to policy-created resources.
`Schedule.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<Tag>`	`variableTags()` A collection of key/value pairs with values determined dynamically when the policy is executed.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public final String name()
```
    The name of the schedule.
    
    Returns:
    
    The name of the schedule.
  - copyTags
```
public final Boolean copyTags()
```
    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.
  - hasTagsToAdd
```
public final boolean hasTagsToAdd()
```
    For responses, this returns true if the service returned a value for the TagsToAdd property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tagsToAdd
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTagsToAdd() method.
    
    Returns:
    
    The tags to apply to policy-created resources. These user-defined tags are in addition to the Amazon Web Services-added lifecycle tags.
  - hasVariableTags
```
public final boolean hasVariableTags()
```
    For responses, this returns true if the service returned a value for the VariableTags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - variableTags
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVariableTags() method.
    
    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.
  - createRule
```
public final CreateRule createRule()
```
    The creation rule.
    
    Returns:
    
    The creation rule.
  - retainRule
```
public final RetainRule retainRule()
```
    The retention rule.
    
    Returns:
    
    The retention rule.
  - fastRestoreRule
```
public final FastRestoreRule fastRestoreRule()
```
    The rule for enabling fast snapshot restore.
    
    Returns:
    
    The rule for enabling fast snapshot restore.
  - hasCrossRegionCopyRules
```
public final boolean hasCrossRegionCopyRules()
```
    For responses, this returns true if the service returned a value for the CrossRegionCopyRules property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - crossRegionCopyRules
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCrossRegionCopyRules() method.
    
    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.
  - hasShareRules
```
public final boolean hasShareRules()
```
    For responses, this returns true if the service returned a value for the ShareRules property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - shareRules
```
public final List<ShareRule> shareRules()
```
    The rule for sharing snapshots with other Amazon Web Services accounts.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasShareRules() method.
    
    Returns:
    
    The rule for sharing snapshots with other Amazon Web Services accounts.
  - deprecateRule
```
public final DeprecateRule deprecateRule()
```
    The AMI deprecation rule for the schedule.
    
    Returns:
    
    The AMI deprecation rule for the schedule.
  - toBuilder
```
public Schedule.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Schedule.Builder,Schedule>
  - builder
```
public static Schedule.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Schedule.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Schedule

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

copyTags

hasTagsToAdd

tagsToAdd

hasVariableTags

variableTags

createRule

retainRule

fastRestoreRule

hasCrossRegionCopyRules

crossRegionCopyRules

hasShareRules

shareRules

deprecateRule

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields