Package software.amazon.awssdk.services.s3.model

Class RecordExpiration

java.lang.Object

software.amazon.awssdk.services.s3.model.RecordExpiration

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class RecordExpiration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RecordExpiration.Builder,RecordExpiration>

The journal table record expiration settings for a journal table in an S3 Metadata configuration.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RecordExpiration.Builder

Method Summary

Modifier and Type	Method	Description
static RecordExpiration.Builder	builder()
Integer	days()	If you enable journal table record expiration, you can set the number of days to retain your journal table records.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ExpirationState	expiration()	Specifies whether journal table record expiration is enabled or disabled.
String	expirationAsString()	Specifies whether journal table record expiration is enabled or disabled.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RecordExpiration.Builder>	serializableBuilderClass()
RecordExpiration.Builder	toBuilder()
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 software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

expiration

public final ExpirationState expiration()

Specifies whether journal table record expiration is enabled or disabled.

If the service returns an enum value that is not available in the current SDK version, expiration will return ExpirationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from expirationAsString().

Returns:

Specifies whether journal table record expiration is enabled or disabled.

See Also:

ExpirationState

expirationAsString

public final String expirationAsString()

Specifies whether journal table record expiration is enabled or disabled.

If the service returns an enum value that is not available in the current SDK version, expiration will return ExpirationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from expirationAsString().

Returns:

Specifies whether journal table record expiration is enabled or disabled.

See Also:

ExpirationState

days

public final Integer days()

If you enable journal table record expiration, you can set the number of days to retain your journal table records. Journal table records must be retained for a minimum of 7 days. To set this value, specify any whole number from 7 to 2147483647. For example, to retain your journal table records for one year, set this value to 365.

Returns:

If you enable journal table record expiration, you can set the number of days to retain your journal table records. Journal table records must be retained for a minimum of 7 days. To set this value, specify any whole number from 7 to 2147483647. For example, to retain your journal table records for one year, set this value to 365.

toBuilder

public RecordExpiration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RecordExpiration.Builder,RecordExpiration>

builder

public static RecordExpiration.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo