com.amazonaws.services.kinesis.model

Class IncreaseStreamRetentionPeriodRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesis.model.IncreaseStreamRetentionPeriodRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class IncreaseStreamRetentionPeriodRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Increases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 168 hours (7 days).

If you choose a longer stream retention period, this operation increases the time period during which records that have not yet expired are accessible. However, it does not make previous, expired data (older than the stream's previous retention period) accessible after the operation has been called. For example, if a stream's retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours remains inaccessible to consumer applications.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IncreaseStreamRetentionPeriodRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Integer	getRetentionPeriodHours() The new retention period of the stream, in hours.
java.lang.String	getStreamName() The name of the stream to modify.
int	hashCode()
void	setRetentionPeriodHours(java.lang.Integer retentionPeriodHours) The new retention period of the stream, in hours.
void	setStreamName(java.lang.String streamName) The name of the stream to modify.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
IncreaseStreamRetentionPeriodRequest	withRetentionPeriodHours(java.lang.Integer retentionPeriodHours) The new retention period of the stream, in hours.
IncreaseStreamRetentionPeriodRequest	withStreamName(java.lang.String streamName) The name of the stream to modify.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IncreaseStreamRetentionPeriodRequest

public IncreaseStreamRetentionPeriodRequest()

Method Detail

getStreamName

public java.lang.String getStreamName()

The name of the stream to modify.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Returns:

The name of the stream to modify.

setStreamName

public void setStreamName(java.lang.String streamName)

The name of the stream to modify.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Parameters:

streamName -

The name of the stream to modify.

withStreamName

public IncreaseStreamRetentionPeriodRequest withStreamName(java.lang.String streamName)

The name of the stream to modify.

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

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Parameters:

streamName -

The name of the stream to modify.

Returns:

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

getRetentionPeriodHours

public java.lang.Integer getRetentionPeriodHours()

The new retention period of the stream, in hours. Must be more than the current retention period.

Constraints:
Range: 1 - 168

Returns:

The new retention period of the stream, in hours. Must be more than the current retention period.

setRetentionPeriodHours

public void setRetentionPeriodHours(java.lang.Integer retentionPeriodHours)

The new retention period of the stream, in hours. Must be more than the current retention period.

Constraints:
Range: 1 - 168

Parameters:

retentionPeriodHours -

The new retention period of the stream, in hours. Must be more than the current retention period.

withRetentionPeriodHours

public IncreaseStreamRetentionPeriodRequest withRetentionPeriodHours(java.lang.Integer retentionPeriodHours)

The new retention period of the stream, in hours. Must be more than the current retention period.

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

Constraints:
Range: 1 - 168

Parameters:

retentionPeriodHours -

The new retention period of the stream, in hours. Must be more than the current retention period.

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