@Generated(value="software.amazon.awssdk:codegen") public final class LifecycleRule extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LifecycleRule.Builder,LifecycleRule>
A lifecycle rule for individual objects in an Amazon S3 bucket.
Modifier and Type | Class and Description |
---|---|
static interface |
LifecycleRule.Builder |
Modifier and Type | Method and Description |
---|---|
AbortIncompleteMultipartUpload |
abortIncompleteMultipartUpload()
Returns the value of the AbortIncompleteMultipartUpload property for this object.
|
static LifecycleRule.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
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.
|
LifecycleRuleFilter |
filter()
The
Filter is used to identify objects that a Lifecycle Rule applies to. |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasNoncurrentVersionTransitions()
For responses, this returns true if the service returned a value for the NoncurrentVersionTransitions property.
|
boolean |
hasTransitions()
For responses, this returns true if the service returned a value for the Transitions property.
|
String |
id()
Unique identifier for the rule.
|
NoncurrentVersionExpiration |
noncurrentVersionExpiration()
Returns the value of the NoncurrentVersionExpiration property for this object.
|
List<NoncurrentVersionTransition> |
noncurrentVersionTransitions()
Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a
specific storage class.
|
String |
prefix()
Deprecated.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends LifecycleRule.Builder> |
serializableBuilderClass() |
ExpirationStatus |
status()
If 'Enabled', the rule is currently being applied.
|
String |
statusAsString()
If 'Enabled', the rule is currently being applied.
|
LifecycleRule.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
List<Transition> |
transitions()
Specifies when an Amazon S3 object transitions to a specified storage class.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
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.
public final String id()
Unique identifier for the rule. The value cannot be longer than 255 characters.
@Deprecated public final String prefix()
Prefix identifying one or more objects to which the rule applies. This is no longer used; use Filter
instead.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
Filter
instead. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
public final LifecycleRuleFilter filter()
The Filter
is used to identify objects that a Lifecycle Rule applies to. A Filter
must
have exactly one of Prefix
, Tag
, or And
specified. Filter
is
required if the LifecycleRule
does not containt a Prefix
element.
Filter
is used to identify objects that a Lifecycle Rule applies to. A
Filter
must have exactly one of Prefix
, Tag
, or And
specified. Filter
is required if the LifecycleRule
does not containt a
Prefix
element.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, status
will
return ExpirationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusAsString()
.
ExpirationStatus
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, status
will
return ExpirationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
statusAsString()
.
ExpirationStatus
public final boolean hasTransitions()
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.public final List<Transition> transitions()
Specifies when an Amazon S3 object transitions to a specified storage class.
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.
public final boolean hasNoncurrentVersionTransitions()
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.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.
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.
public final NoncurrentVersionExpiration noncurrentVersionExpiration()
public final AbortIncompleteMultipartUpload abortIncompleteMultipartUpload()
public LifecycleRule.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<LifecycleRule.Builder,LifecycleRule>
public static LifecycleRule.Builder builder()
public static Class<? extends LifecycleRule.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2021. All rights reserved.