Class LifecyclePolicy
- java.lang.Object
-
- software.amazon.awssdk.services.dlm.model.LifecyclePolicy
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<LifecyclePolicy.Builder,LifecyclePolicy>
@Generated("software.amazon.awssdk:codegen") public final class LifecyclePolicy extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LifecyclePolicy.Builder,LifecyclePolicy>
[All policy types] Detailed information about a snapshot, AMI, or event-based lifecycle policy.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceLifecyclePolicy.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static LifecyclePolicy.Builderbuilder()InstantdateCreated()The local date and time when the lifecycle policy was created.InstantdateModified()The local date and time when the lifecycle policy was last modified.Stringdescription()The description of the lifecycle policy.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringexecutionRoleArn()The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringpolicyArn()The Amazon Resource Name (ARN) of the policy.PolicyDetailspolicyDetails()The configuration of the lifecycle policyStringpolicyId()The identifier of the lifecycle policy.List<SdkField<?>>sdkFields()static Class<? extends LifecyclePolicy.Builder>serializableBuilderClass()GettablePolicyStateValuesstate()The activation state of the lifecycle policy.StringstateAsString()The activation state of the lifecycle policy.StringstatusMessage()The description of the status.Map<String,String>tags()The tags.LifecyclePolicy.BuildertoBuilder()StringtoString()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
-
policyId
public final String policyId()
The identifier of the lifecycle policy.
- Returns:
- The identifier of the lifecycle policy.
-
description
public final String description()
The description of the lifecycle policy.
- Returns:
- The description of the lifecycle policy.
-
state
public final GettablePolicyStateValues state()
The activation state of the lifecycle policy.
If the service returns an enum value that is not available in the current SDK version,
statewill returnGettablePolicyStateValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The activation state of the lifecycle policy.
- See Also:
GettablePolicyStateValues
-
stateAsString
public final String stateAsString()
The activation state of the lifecycle policy.
If the service returns an enum value that is not available in the current SDK version,
statewill returnGettablePolicyStateValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The activation state of the lifecycle policy.
- See Also:
GettablePolicyStateValues
-
statusMessage
public final String statusMessage()
The description of the status.
- Returns:
- The description of the status.
-
executionRoleArn
public final String executionRoleArn()
The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
- Returns:
- The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
-
dateCreated
public final Instant dateCreated()
The local date and time when the lifecycle policy was created.
- Returns:
- The local date and time when the lifecycle policy was created.
-
dateModified
public final Instant dateModified()
The local date and time when the lifecycle policy was last modified.
- Returns:
- The local date and time when the lifecycle policy was last modified.
-
policyDetails
public final PolicyDetails policyDetails()
The configuration of the lifecycle policy
- Returns:
- The configuration of the lifecycle policy
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
tags
public final Map<String,String> tags()
The 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
hasTags()method.- Returns:
- The tags.
-
policyArn
public final String policyArn()
The Amazon Resource Name (ARN) of the policy.
- Returns:
- The Amazon Resource Name (ARN) of the policy.
-
toBuilder
public LifecyclePolicy.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<LifecyclePolicy.Builder,LifecyclePolicy>
-
builder
public static LifecyclePolicy.Builder builder()
-
serializableBuilderClass
public static Class<? extends LifecyclePolicy.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-