public class DecreaseStreamRetentionPeriodRequest extends AmazonWebServiceRequest implements Serializable
Decreases 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 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.
Constructor and Description |
---|
DecreaseStreamRetentionPeriodRequest() |
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.
|
DecreaseStreamRetentionPeriodRequest |
withRetentionPeriodHours(Integer retentionPeriodHours)
The new retention period of the stream, in hours.
|
DecreaseStreamRetentionPeriodRequest |
withStreamName(String streamName)
The name of the stream to modify.
|
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public DecreaseStreamRetentionPeriodRequest()
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 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_.-]+
streamName
- The name of the stream to modify.
public Integer getRetentionPeriodHours()
The new retention period of the stream, in hours. Must be less than the current retention period.
Constraints:
Range: 24 - 168
The new retention period of the stream, in hours. Must be less than the current retention period.
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
retentionPeriodHours
- The new retention period of the stream, in hours. Must be less than the current retention period.
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
retentionPeriodHours
- The new retention period of the stream, in hours. Must be less than the current retention period.
public String toString()
toString
in class Object
Object.toString()
Copyright © 2017. All rights reserved.