Interface PolicyDetails.Builder

All Superinterfaces:
Buildable, CopyableBuilder<PolicyDetails.Builder,PolicyDetails>, SdkBuilder<PolicyDetails.Builder,PolicyDetails>, SdkPojo
Enclosing class:
PolicyDetails

public static interface PolicyDetails.Builder extends SdkPojo, CopyableBuilder<PolicyDetails.Builder,PolicyDetails>
  • Method Details

    • policyType

      PolicyDetails.Builder policyType(String policyType)

      [Custom policies only] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.

      The default is EBS_SNAPSHOT_MANAGEMENT.

      Parameters:
      policyType - [Custom policies only] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.

      The default is EBS_SNAPSHOT_MANAGEMENT.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • policyType

      PolicyDetails.Builder policyType(PolicyTypeValues policyType)

      [Custom policies only] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.

      The default is EBS_SNAPSHOT_MANAGEMENT.

      Parameters:
      policyType - [Custom policies only] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.

      The default is EBS_SNAPSHOT_MANAGEMENT.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • resourceTypesWithStrings

      PolicyDetails.Builder resourceTypesWithStrings(Collection<String> resourceTypes)

      [Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

      Parameters:
      resourceTypes - [Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • resourceTypesWithStrings

      PolicyDetails.Builder resourceTypesWithStrings(String... resourceTypes)

      [Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

      Parameters:
      resourceTypes - [Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • resourceTypes

      PolicyDetails.Builder resourceTypes(Collection<ResourceTypeValues> resourceTypes)

      [Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

      Parameters:
      resourceTypes - [Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • resourceTypes

      PolicyDetails.Builder resourceTypes(ResourceTypeValues... resourceTypes)

      [Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

      Parameters:
      resourceTypes - [Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • resourceLocationsWithStrings

      PolicyDetails.Builder resourceLocationsWithStrings(Collection<String> resourceLocations)

      [Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

      If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

      Parameters:
      resourceLocations - [Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

      If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

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

      PolicyDetails.Builder resourceLocationsWithStrings(String... resourceLocations)

      [Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

      If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

      Parameters:
      resourceLocations - [Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

      If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

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

      PolicyDetails.Builder resourceLocations(Collection<ResourceLocationValues> resourceLocations)

      [Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

      If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

      Parameters:
      resourceLocations - [Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

      If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

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

      PolicyDetails.Builder resourceLocations(ResourceLocationValues... resourceLocations)

      [Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

      If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

      Parameters:
      resourceLocations - [Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST.

      If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

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

      PolicyDetails.Builder targetTags(Collection<Tag> targetTags)

      [Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.

      Parameters:
      targetTags - [Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • targetTags

      PolicyDetails.Builder targetTags(Tag... targetTags)

      [Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.

      Parameters:
      targetTags - [Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • targetTags

      PolicyDetails.Builder targetTags(Consumer<Tag.Builder>... targetTags)

      [Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targetTags(List<Tag>).

      Parameters:
      targetTags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • schedules

      PolicyDetails.Builder schedules(Collection<Schedule> schedules)

      [Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.

      Parameters:
      schedules - [Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • schedules

      PolicyDetails.Builder schedules(Schedule... schedules)

      [Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.

      Parameters:
      schedules - [Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • schedules

      [Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.

      This is a convenience method that creates an instance of the Schedule.Builder avoiding the need to create one manually via Schedule.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to schedules(List<Schedule>).

      Parameters:
      schedules - a consumer that will call methods on Schedule.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • parameters

      PolicyDetails.Builder parameters(Parameters parameters)

      [Custom snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.

      If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.

      Parameters:
      parameters - [Custom snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.

      If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.

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

      default PolicyDetails.Builder parameters(Consumer<Parameters.Builder> parameters)

      [Custom snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.

      If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null.

      This is a convenience method that creates an instance of the Parameters.Builder avoiding the need to create one manually via Parameters.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parameters(Parameters).

      Parameters:
      parameters - a consumer that will call methods on Parameters.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • eventSource

      PolicyDetails.Builder eventSource(EventSource eventSource)

      [Event-based policies only] The event that activates the event-based policy.

      Parameters:
      eventSource - [Event-based policies only] The event that activates the event-based policy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • eventSource

      default PolicyDetails.Builder eventSource(Consumer<EventSource.Builder> eventSource)

      [Event-based policies only] The event that activates the event-based policy.

      This is a convenience method that creates an instance of the EventSource.Builder avoiding the need to create one manually via EventSource.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to eventSource(EventSource).

      Parameters:
      eventSource - a consumer that will call methods on EventSource.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • actions

      [Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.

      Parameters:
      actions - [Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • actions

      PolicyDetails.Builder actions(Action... actions)

      [Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.

      Parameters:
      actions - [Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • actions

      [Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify only one action per policy.

      This is a convenience method that creates an instance of the Action.Builder avoiding the need to create one manually via Action.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to actions(List<Action>).

      Parameters:
      actions - a consumer that will call methods on Action.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • policyLanguage

      PolicyDetails.Builder policyLanguage(String policyLanguage)

      The type of policy to create. Specify one of the following:

      • SIMPLIFIED To create a default policy.

      • STANDARD To create a custom policy.

      Parameters:
      policyLanguage - The type of policy to create. Specify one of the following:

      • SIMPLIFIED To create a default policy.

      • STANDARD To create a custom policy.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • policyLanguage

      PolicyDetails.Builder policyLanguage(PolicyLanguageValues policyLanguage)

      The type of policy to create. Specify one of the following:

      • SIMPLIFIED To create a default policy.

      • STANDARD To create a custom policy.

      Parameters:
      policyLanguage - The type of policy to create. Specify one of the following:

      • SIMPLIFIED To create a default policy.

      • STANDARD To create a custom policy.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • resourceType

      PolicyDetails.Builder resourceType(String resourceType)

      [Default policies only] Specify the type of default policy to create.

      • To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME.

      • To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE.

      Parameters:
      resourceType - [Default policies only] Specify the type of default policy to create.

      • To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME.

      • To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • resourceType

      PolicyDetails.Builder resourceType(ResourceTypeValues resourceType)

      [Default policies only] Specify the type of default policy to create.

      • To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME.

      • To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE.

      Parameters:
      resourceType - [Default policies only] Specify the type of default policy to create.

      • To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME.

      • To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • createInterval

      PolicyDetails.Builder createInterval(Integer createInterval)

      [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.

      Default: 1

      Parameters:
      createInterval - [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.

      Default: 1

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

      PolicyDetails.Builder retainInterval(Integer retainInterval)

      [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.

      Default: 7

      Parameters:
      retainInterval - [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.

      Default: 7

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

      PolicyDetails.Builder copyTags(Boolean copyTags)

      [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false.

      Default: false

      Parameters:
      copyTags - [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false.

      Default: false

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

      PolicyDetails.Builder crossRegionCopyTargets(Collection<CrossRegionCopyTarget> crossRegionCopyTargets)

      [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.

      Parameters:
      crossRegionCopyTargets - [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • crossRegionCopyTargets

      PolicyDetails.Builder crossRegionCopyTargets(CrossRegionCopyTarget... crossRegionCopyTargets)

      [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.

      Parameters:
      crossRegionCopyTargets - [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • crossRegionCopyTargets

      PolicyDetails.Builder crossRegionCopyTargets(Consumer<CrossRegionCopyTarget.Builder>... crossRegionCopyTargets)

      [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.

      This is a convenience method that creates an instance of the CrossRegionCopyTarget.Builder avoiding the need to create one manually via CrossRegionCopyTarget.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to crossRegionCopyTargets(List<CrossRegionCopyTarget>).

      Parameters:
      crossRegionCopyTargets - a consumer that will call methods on CrossRegionCopyTarget.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • extendDeletion

      PolicyDetails.Builder extendDeletion(Boolean extendDeletion)

      [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.

      By default (ExtendDeletion=false):

      • If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify true.

      • If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify true.

      If you enable extended deletion (ExtendDeletion=true), you override both default behaviors simultaneously.

      If you do not specify a value, the default is false.

      Default: false

      Parameters:
      extendDeletion - [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.

      By default (ExtendDeletion=false):

      • If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify true.

      • If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify true.

      If you enable extended deletion (ExtendDeletion=true), you override both default behaviors simultaneously.

      If you do not specify a value, the default is false.

      Default: false

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

      PolicyDetails.Builder exclusions(Exclusions exclusions)

      [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.

      Parameters:
      exclusions - [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • exclusions

      default PolicyDetails.Builder exclusions(Consumer<Exclusions.Builder> exclusions)

      [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.

      This is a convenience method that creates an instance of the Exclusions.Builder avoiding the need to create one manually via Exclusions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to exclusions(Exclusions).

      Parameters:
      exclusions - a consumer that will call methods on Exclusions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: