com.amazonaws.services.kinesis.model

Class DecreaseStreamRetentionPeriodRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesis.model.DecreaseStreamRetentionPeriodRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DecreaseStreamRetentionPeriodRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DecreaseStreamRetentionPeriod operation.

Decreases the stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream???s retention period is 24 hours.

This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible.

See Also:

AmazonKinesis.decreaseStreamRetentionPeriod(DecreaseStreamRetentionPeriodRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DecreaseStreamRetentionPeriodRequest()

Method Summary

Methods

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

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DecreaseStreamRetentionPeriodRequest

public DecreaseStreamRetentionPeriodRequest()

Method Detail

getStreamName

public 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(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 DecreaseStreamRetentionPeriodRequest withStreamName(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 Integer getRetentionPeriodHours()

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

Constraints:
Range: 24 - 168

Returns:

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

setRetentionPeriodHours

public void setRetentionPeriodHours(Integer retentionPeriodHours)

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

Constraints:
Range: 24 - 168

Parameters:

retentionPeriodHours - The new retention period of the stream, in hours. Must be less than the current retention period.

withRetentionPeriodHours

public DecreaseStreamRetentionPeriodRequest withRetentionPeriodHours(Integer retentionPeriodHours)

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

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

Constraints:
Range: 24 - 168

Parameters:

retentionPeriodHours - The new retention period of the stream, in hours. Must be less than the current retention period.

Returns:

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

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DecreaseStreamRetentionPeriodRequest clone()

Overrides:

clone in class AmazonWebServiceRequest