Class AwsS3BucketBucketLifecycleConfigurationRulesDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AwsS3BucketBucketLifecycleConfigurationRulesDetails.Builder,
AwsS3BucketBucketLifecycleConfigurationRulesDetails>
Configuration for a lifecycle rule.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionHow Amazon S3 responds when a multipart upload is incomplete.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The date when objects are moved or deleted.final Integer
The length in days of the lifetime for objects that are subject to the rule.final Boolean
Whether Amazon S3 removes a delete marker that has no noncurrent versions.filter()
Identifies the objects that a rule applies to.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the NoncurrentVersionTransitions property.final boolean
For responses, this returns true if the service returned a value for the Transitions property.final String
id()
The unique identifier of the rule.final Integer
The number of days that an object is noncurrent before Amazon S3 can perform the associated action.Transition rules that describe when noncurrent objects transition to a specified storage class.final String
prefix()
A prefix that identifies one or more objects that the rule applies to.static Class
<? extends AwsS3BucketBucketLifecycleConfigurationRulesDetails.Builder> final String
status()
The current status of the rule.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Transition rules that indicate when objects transition to a specified storage class.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
abortIncompleteMultipartUpload
public final AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails abortIncompleteMultipartUpload()How Amazon S3 responds when a multipart upload is incomplete. Specifically, provides a number of days before Amazon S3 cancels the entire upload.
- Returns:
- How Amazon S3 responds when a multipart upload is incomplete. Specifically, provides a number of days before Amazon S3 cancels the entire upload.
-
expirationDate
The date when objects are moved or deleted.
This field accepts only the specified formats. Timestamps can end with
Z
or("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:-
YYYY-MM-DDTHH:MM:SSZ
(for example,2019-01-31T23:00:00Z
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example,2019-01-31T23:00:00.123456789Z
) -
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example,2024-01-04T15:25:10+17:59
) -
YYYY-MM-DDTHH:MM:SS-HHMM
(for example,2024-01-04T15:25:10-1759
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,2024-01-04T15:25:10.123456789+17:59
)
- Returns:
- The date when objects are moved or deleted.
This field accepts only the specified formats. Timestamps can end with
Z
or("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:-
YYYY-MM-DDTHH:MM:SSZ
(for example,2019-01-31T23:00:00Z
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example,2019-01-31T23:00:00.123456789Z
) -
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example,2024-01-04T15:25:10+17:59
) -
YYYY-MM-DDTHH:MM:SS-HHMM
(for example,2024-01-04T15:25:10-1759
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,2024-01-04T15:25:10.123456789+17:59
)
-
-
-
expirationInDays
The length in days of the lifetime for objects that are subject to the rule.
- Returns:
- The length in days of the lifetime for objects that are subject to the rule.
-
expiredObjectDeleteMarker
Whether Amazon S3 removes a delete marker that has no noncurrent versions. If set to
true
, the delete marker is expired. If set tofalse
, the policy takes no action.If you provide
ExpiredObjectDeleteMarker
, you cannot provideExpirationInDays
orExpirationDate
.- Returns:
- Whether Amazon S3 removes a delete marker that has no noncurrent versions. If set to
true
, the delete marker is expired. If set tofalse
, the policy takes no action.If you provide
ExpiredObjectDeleteMarker
, you cannot provideExpirationInDays
orExpirationDate
.
-
filter
Identifies the objects that a rule applies to.
- Returns:
- Identifies the objects that a rule applies to.
-
id
The unique identifier of the rule.
- Returns:
- The unique identifier of the rule.
-
noncurrentVersionExpirationInDays
The number of days that an object is noncurrent before Amazon S3 can perform the associated action.
- Returns:
- The number of days that an object is noncurrent before Amazon S3 can perform the associated action.
-
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<AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails> noncurrentVersionTransitions()Transition rules that describe when noncurrent objects transition 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
hasNoncurrentVersionTransitions()
method.- Returns:
- Transition rules that describe when noncurrent objects transition to a specified storage class.
-
prefix
A prefix that identifies one or more objects that the rule applies to.
- Returns:
- A prefix that identifies one or more objects that the rule applies to.
-
status
The current status of the rule. Indicates whether the rule is currently being applied.
- Returns:
- The current status of the rule. Indicates whether the rule is currently being applied.
-
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
Transition rules that indicate when objects transition 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.- Returns:
- Transition rules that indicate when objects transition to a specified storage class.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AwsS3BucketBucketLifecycleConfigurationRulesDetails.Builder,
AwsS3BucketBucketLifecycleConfigurationRulesDetails> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends AwsS3BucketBucketLifecycleConfigurationRulesDetails.Builder> serializableBuilderClass() -
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-