com.ibm.cos.v2.services.s3.model

Class LifecycleExpiration

java.lang.Object

com.ibm.cos.v2.services.s3.model.LifecycleExpiration

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<LifecycleExpiration.Builder,LifecycleExpiration>, Serializable

@Generated(value="com.ibm.cos.v2:codegen")
public final class LifecycleExpiration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LifecycleExpiration.Builder,LifecycleExpiration>

Container for the expiration for the lifecycle of the object.

For more information see, Managing your storage lifecycle in the Amazon S3 User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LifecycleExpiration.Builder

Method Summary

Modifier and Type	Method and Description
static LifecycleExpiration.Builder	builder()
Instant	date() Indicates at what date the object is to be moved or deleted.
Integer	days() Indicates the lifetime, in days, of the objects that are subject to the rule.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
Boolean	expiredObjectDeleteMarker() Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends LifecycleExpiration.Builder>	serializableBuilderClass()
LifecycleExpiration.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
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 com.ibm.cos.v2.utils.builder.ToCopyableBuilder

copy

Method Detail

date

public final Instant date()

Indicates at what date the object is to be moved or deleted. The date value must conform to the ISO 8601 format. The time is always midnight UTC.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

Returns:

Indicates at what date the object is to be moved or deleted. The date value must conform to the ISO 8601 format. The time is always midnight UTC.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

days

public final Integer days()

Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.

Returns:

Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.

expiredObjectDeleteMarker

public final Boolean expiredObjectDeleteMarker()

Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

Returns:

Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

toBuilder

public LifecycleExpiration.Builder 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 interface ToCopyableBuilder<LifecycleExpiration.Builder,LifecycleExpiration>

Returns:

a builder for type T

builder

public static LifecycleExpiration.Builder builder()

serializableBuilderClass

public static Class<? extends LifecycleExpiration.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)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.