public class IncreaseStreamRetentionPeriodRequest extends AmazonWebServiceRequest implements Serializable
Increases the Amazon Kinesis 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).
Upon choosing a longer stream retention period, this operation will increase the time period records are accessible that have not yet expired. However, it will not make previous data that has expired (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 will remain inaccessible to consumer applications.
Constructor and Description |
---|
IncreaseStreamRetentionPeriodRequest() |
Modifier and Type | Method and Description |
---|---|
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.
|
IncreaseStreamRetentionPeriodRequest |
withRetentionPeriodHours(Integer retentionPeriodHours)
The new retention period of the stream, in hours.
|
IncreaseStreamRetentionPeriodRequest |
withStreamName(String streamName)
The name of the stream to modify.
|
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public IncreaseStreamRetentionPeriodRequest()
public String getStreamName()
The name of the stream to modify.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
The name of the stream to modify.
public void setStreamName(String streamName)
The name of the stream to modify.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
streamName
- The name of the stream to modify.
public IncreaseStreamRetentionPeriodRequest 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_.-]+
streamName
- The name of the stream to modify.
public Integer getRetentionPeriodHours()
The new retention period of the stream, in hours. Must be more than the current retention period.
Constraints:
Range: 24 - 168
The new retention period of the stream, in hours. Must be more than the current retention period.
public void setRetentionPeriodHours(Integer retentionPeriodHours)
The new retention period of the stream, in hours. Must be more than the current retention period.
Constraints:
Range: 24 - 168
retentionPeriodHours
- The new retention period of the stream, in hours. Must be more than the current retention period.
public IncreaseStreamRetentionPeriodRequest withRetentionPeriodHours(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: 24 - 168
retentionPeriodHours
- The new retention period of the stream, in hours. Must be more than the current retention period.
public String toString()
toString
in class Object
Object.toString()
Copyright © 2017. All rights reserved.