Class LifecycleRule
- java.lang.Object
-
- software.amazon.awssdk.services.s3control.model.LifecycleRule
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<LifecycleRule.Builder,LifecycleRule>
@Generated("software.amazon.awssdk:codegen") public final class LifecycleRule extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LifecycleRule.Builder,LifecycleRule>
The container for the Outposts bucket lifecycle rule.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceLifecycleRule.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AbortIncompleteMultipartUploadabortIncompleteMultipartUpload()Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 waits before permanently removing all parts of the upload.static LifecycleRule.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)LifecycleExpirationexpiration()Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.LifecycleRuleFilterfilter()The container for the filter of lifecycle rule.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasNoncurrentVersionTransitions()For responses, this returns true if the service returned a value for the NoncurrentVersionTransitions property.booleanhasTransitions()For responses, this returns true if the service returned a value for the Transitions property.Stringid()Unique identifier for the rule.NoncurrentVersionExpirationnoncurrentVersionExpiration()The noncurrent version expiration of the lifecycle rule.List<NoncurrentVersionTransition>noncurrentVersionTransitions()Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class.List<SdkField<?>>sdkFields()static Class<? extends LifecycleRule.Builder>serializableBuilderClass()ExpirationStatusstatus()If 'Enabled', the rule is currently being applied.StringstatusAsString()If 'Enabled', the rule is currently being applied.LifecycleRule.BuildertoBuilder()StringtoString()Returns a string representation of this object.List<Transition>transitions()Specifies when an Amazon S3 object transitions to a specified storage class.-
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
-
expiration
public final LifecycleExpiration expiration()
Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.
- Returns:
- Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.
-
id
public final String id()
Unique identifier for the rule. The value cannot be longer than 255 characters.
- Returns:
- Unique identifier for the rule. The value cannot be longer than 255 characters.
-
filter
public final LifecycleRuleFilter filter()
The container for the filter of lifecycle rule.
- Returns:
- The container for the filter of lifecycle rule.
-
status
public final ExpirationStatus status()
If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnExpirationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.
- See Also:
ExpirationStatus
-
statusAsString
public final String statusAsString()
If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnExpirationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.
- See Also:
ExpirationStatus
-
hasTransitions
public final boolean hasTransitions()
For responses, this returns true if the service returned a value for the Transitions 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.
-
transitions
public final List<Transition> transitions()
Specifies when an Amazon S3 object transitions to a specified storage class.
This is not supported by Amazon S3 on Outposts buckets.
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
hasTransitions()method.- Returns:
- Specifies when an Amazon S3 object transitions to a specified storage class.
This is not supported by Amazon S3 on Outposts buckets.
-
hasNoncurrentVersionTransitions
public final boolean hasNoncurrentVersionTransitions()
For responses, this returns true if the service returned a value for the NoncurrentVersionTransitions 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.
-
noncurrentVersionTransitions
public final List<NoncurrentVersionTransition> noncurrentVersionTransitions()
Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.
This is not supported by Amazon S3 on Outposts buckets.
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
hasNoncurrentVersionTransitions()method.- Returns:
- Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to
a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set
this action to request that Amazon S3 transition noncurrent object versions to a specific storage class
at a set period in the object's lifetime.
This is not supported by Amazon S3 on Outposts buckets.
-
noncurrentVersionExpiration
public final NoncurrentVersionExpiration noncurrentVersionExpiration()
The noncurrent version expiration of the lifecycle rule.
- Returns:
- The noncurrent version expiration of the lifecycle rule.
-
abortIncompleteMultipartUpload
public final AbortIncompleteMultipartUpload abortIncompleteMultipartUpload()
Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 waits before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration in the Amazon S3 User Guide.
- Returns:
- Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 waits before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration in the Amazon S3 User Guide.
-
toBuilder
public LifecycleRule.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<LifecycleRule.Builder,LifecycleRule>
-
builder
public static LifecycleRule.Builder builder()
-
serializableBuilderClass
public static Class<? extends LifecycleRule.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.
-
-