com.amazonaws.services.dynamodbv2.model

Class UpdateTimeToLiveRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.dynamodbv2.model.UpdateTimeToLiveRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class UpdateTimeToLiveRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable

The UpdateTimeToLive method will enable or disable TTL for the specified table. A successful UpdateTimeToLive call returns the current TimeToLiveSpecification; it may take up to one hour for the change to fully process. Any additional UpdateTimeToLive calls for the same table during this one hour duration result in a ValidationException.

TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted.

The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1st, 1970 UTC.

DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations.

DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans.

As items are deleted, they are removed from any Local Secondary Index and Global Secondary Index immediately in the same eventually consistent way as a standard delete operation.

For more information, see Time To Live in the Amazon DynamoDB Developer Guide.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UpdateTimeToLiveRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getTableName() The name of the table to be configured.
TimeToLiveSpecification	getTimeToLiveSpecification() Represents the settings used to enable or disable Time to Live for the specified table.
int	hashCode()
void	setTableName(java.lang.String tableName) The name of the table to be configured.
void	setTimeToLiveSpecification(TimeToLiveSpecification timeToLiveSpecification) Represents the settings used to enable or disable Time to Live for the specified table.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateTimeToLiveRequest	withTableName(java.lang.String tableName) The name of the table to be configured.
UpdateTimeToLiveRequest	withTimeToLiveSpecification(TimeToLiveSpecification timeToLiveSpecification) Represents the settings used to enable or disable Time to Live for the specified table.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateTimeToLiveRequest

public UpdateTimeToLiveRequest()

Method Detail

getTableName

public java.lang.String getTableName()

The name of the table to be configured.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Returns:

The name of the table to be configured.

setTableName

public void setTableName(java.lang.String tableName)

The name of the table to be configured.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Parameters:

tableName -

The name of the table to be configured.

withTableName

public UpdateTimeToLiveRequest withTableName(java.lang.String tableName)

The name of the table to be configured.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+

Parameters:

tableName -

The name of the table to be configured.

Returns:

A reference to this updated object so that method calls can be chained together.

getTimeToLiveSpecification

public TimeToLiveSpecification getTimeToLiveSpecification()

Represents the settings used to enable or disable Time to Live for the specified table.

Returns:

Represents the settings used to enable or disable Time to Live for the specified table.

setTimeToLiveSpecification

public void setTimeToLiveSpecification(TimeToLiveSpecification timeToLiveSpecification)

Represents the settings used to enable or disable Time to Live for the specified table.

Parameters:

timeToLiveSpecification -

Represents the settings used to enable or disable Time to Live for the specified table.

withTimeToLiveSpecification

public UpdateTimeToLiveRequest withTimeToLiveSpecification(TimeToLiveSpecification timeToLiveSpecification)

Represents the settings used to enable or disable Time to Live for the specified table.

Returns a reference to this object so that method calls can be chained together.

Parameters:

timeToLiveSpecification -

Represents the settings used to enable or disable Time to Live for the specified table.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object