PolicyDetails (AWS Java SDK :: Services

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

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<PolicyDetails.Builder,PolicyDetails>

@Generated(value="software.amazon.awssdk:codegen")
public final class PolicyDetails
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PolicyDetails.Builder,PolicyDetails>

Specifies the configuration of a lifecycle policy.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PolicyDetails.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<Action>`	`actions()` The actions to be performed when the event-based policy is triggered.
`static PolicyDetails.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`EventSource`	`eventSource()` The event that triggers the event-based policy.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasActions()` For responses, this returns true if the service returned a value for the Actions property.
`int`	`hashCode()`
`boolean`	`hasResourceLocations()` For responses, this returns true if the service returned a value for the ResourceLocations property.
`boolean`	`hasResourceTypes()` For responses, this returns true if the service returned a value for the ResourceTypes property.
`boolean`	`hasSchedules()` For responses, this returns true if the service returned a value for the Schedules property.
`boolean`	`hasTargetTags()` For responses, this returns true if the service returned a value for the TargetTags property.
`Parameters`	`parameters()` A set of optional parameters for snapshot and AMI lifecycle policies.
`PolicyTypeValues`	`policyType()` The valid target resource types and actions a policy can manage.
`String`	`policyTypeAsString()` The valid target resource types and actions a policy can manage.
`List<ResourceLocationValues>`	`resourceLocations()` The location of the resources to backup.
`List<String>`	`resourceLocationsAsStrings()` The location of the resources to backup.
`List<ResourceTypeValues>`	`resourceTypes()` The target resource type for snapshot and AMI lifecycle policies.
`List<String>`	`resourceTypesAsStrings()` The target resource type for snapshot and AMI lifecycle policies.
`List<Schedule>`	`schedules()` The schedules of policy-defined actions for snapshot and AMI lifecycle policies.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PolicyDetails.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`targetTags()` The single tag that identifies targeted resources for this policy.
`PolicyDetails.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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
  - policyType
```
public final PolicyTypeValues policyType()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, policyType will return PolicyTypeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyTypeAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    PolicyTypeValues
  - policyTypeAsString
```
public final String policyTypeAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, policyType will return PolicyTypeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyTypeAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    PolicyTypeValues
  - resourceTypes
```
public final List<ResourceTypeValues> resourceTypes()
```
    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.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    
    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 hasResourceTypes() method.
    
    Returns:
    
    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.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
  - hasResourceTypes
```
public final boolean hasResourceTypes()
```
    For responses, this returns true if the service returned a value for the ResourceTypes 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.
  - resourceTypesAsStrings
```
public final List<String> resourceTypesAsStrings()
```
    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.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    
    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 hasResourceTypes() method.
    
    Returns:
    
    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.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
  - resourceLocations
```
public final List<ResourceLocationValues> resourceLocations()
```
    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.
    
    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 hasResourceLocations() method.
    
    Returns:
    
    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.
  - hasResourceLocations
```
public final boolean hasResourceLocations()
```
    For responses, this returns true if the service returned a value for the ResourceLocations 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.
  - resourceLocationsAsStrings
```
public final List<String> resourceLocationsAsStrings()
```
    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.
    
    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 hasResourceLocations() method.
    
    Returns:
    
    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.
  - hasTargetTags
```
public final boolean hasTargetTags()
```
    For responses, this returns true if the service returned a value for the TargetTags 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.
  - targetTags
```
public final List<Tag> targetTags()
```
    The single tag that identifies targeted resources for this policy.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    
    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 hasTargetTags() method.
    
    Returns:
    
    The single tag that identifies targeted resources for this policy.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
  - hasSchedules
```
public final boolean hasSchedules()
```
    For responses, this returns true if the service returned a value for the Schedules 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.
  - schedules
```
public final List<Schedule> schedules()
```
    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 parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    
    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 hasSchedules() method.
    
    Returns:
    
    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 parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
  - parameters
```
public final Parameters parameters()
```
    A set of optional parameters for snapshot and AMI lifecycle policies.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
    
    Returns:
    
    A set of optional parameters for snapshot and AMI lifecycle policies.
    
    This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.
  - eventSource
```
public final EventSource eventSource()
```
    The event that triggers the event-based policy.
    
    This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
    
    Returns:
    
    The event that triggers the event-based policy.
    
    This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
  - hasActions
```
public final boolean hasActions()
```
    For responses, this returns true if the service returned a value for the Actions 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.
  - actions
```
public final List<Action> actions()
```
    The actions to be performed when the event-based policy is triggered. You can specify only one action per policy.
    
    This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
    
    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 hasActions() method.
    
    Returns:
    
    The actions to be performed when the event-based policy is triggered. You can specify only one action per policy.
    
    This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter.
  - toBuilder
```
public PolicyDetails.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PolicyDetails.Builder,PolicyDetails>
  - builder
```
public static PolicyDetails.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PolicyDetails.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 PolicyDetails

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

policyType

policyTypeAsString

resourceTypes

hasResourceTypes

resourceTypesAsStrings

resourceLocations

hasResourceLocations

resourceLocationsAsStrings

hasTargetTags

targetTags

hasSchedules

schedules

parameters

eventSource

hasActions

actions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields