UpdateDataRetentionRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.kinesisvideo.model.UpdateDataRetentionRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class UpdateDataRetentionRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Increases or decreases the stream's data retention period by the value that you specify. To indicate whether you want to increase or decrease the data retention period, specify the Operation parameter in the request body. In the request, you must specify either the StreamName or the StreamARN.

The retention period that you specify replaces the current value.

This operation requires permission for the KinesisVideo:UpdateDataRetention action.

Changing the data retention period affects the data in the stream as follows:
- If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours.
- If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately.
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

UpdateDataRetentionRequest()

Constructors
Constructor and Description
`UpdateDataRetentionRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getCurrentVersion()` The version of the stream whose retention period you want to change.
`java.lang.Integer`	`getDataRetentionChangeInHours()` The retention period, in hours.
`java.lang.String`	`getOperation()` Indicates whether you want to increase or decrease the retention period.
`java.lang.String`	`getStreamARN()` The Amazon Resource Name (ARN) of the stream whose retention period you want to change.
`java.lang.String`	`getStreamName()` The name of the stream whose retention period you want to change.
`int`	`hashCode()`
`void`	`setCurrentVersion(java.lang.String currentVersion)` The version of the stream whose retention period you want to change.
`void`	`setDataRetentionChangeInHours(java.lang.Integer dataRetentionChangeInHours)` The retention period, in hours.
`void`	`setOperation(java.lang.String operation)` Indicates whether you want to increase or decrease the retention period.
`void`	`setOperation(UpdateDataRetentionOperation operation)` Indicates whether you want to increase or decrease the retention period.
`void`	`setStreamARN(java.lang.String streamARN)` The Amazon Resource Name (ARN) of the stream whose retention period you want to change.
`void`	`setStreamName(java.lang.String streamName)` The name of the stream whose retention period you want to change.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`UpdateDataRetentionRequest`	`withCurrentVersion(java.lang.String currentVersion)` The version of the stream whose retention period you want to change.
`UpdateDataRetentionRequest`	`withDataRetentionChangeInHours(java.lang.Integer dataRetentionChangeInHours)` The retention period, in hours.
`UpdateDataRetentionRequest`	`withOperation(java.lang.String operation)` Indicates whether you want to increase or decrease the retention period.
`UpdateDataRetentionRequest`	`withOperation(UpdateDataRetentionOperation operation)` Indicates whether you want to increase or decrease the retention period.
`UpdateDataRetentionRequest`	`withStreamARN(java.lang.String streamARN)` The Amazon Resource Name (ARN) of the stream whose retention period you want to change.
`UpdateDataRetentionRequest`	`withStreamName(java.lang.String streamName)` The name of the stream whose retention period you want to change.

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
  - UpdateDataRetentionRequest
```
public UpdateDataRetentionRequest()
```
- Method Detail
  - getStreamName
```
public java.lang.String getStreamName()
```
    The name of the stream whose retention period you want to change.
    
    Constraints:
    Length: 1 - 256
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    
    The name of the stream whose retention period you want to change.
  - setStreamName
```
public void setStreamName(java.lang.String streamName)
```
    The name of the stream whose retention period you want to change.
    
    Constraints:
    Length: 1 - 256
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    streamName -
    The name of the stream whose retention period you want to change.
  - withStreamName
```
public UpdateDataRetentionRequest withStreamName(java.lang.String streamName)
```
    The name of the stream whose retention period you want to change.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 256
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    streamName -
    The name of the stream whose retention period you want to change.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getStreamARN
```
public java.lang.String getStreamARN()
```
    The Amazon Resource Name (ARN) of the stream whose retention period you want to change.
    
    Constraints:
    Length: 1 - 1024
    Pattern: arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
    
    Returns:
    
    The Amazon Resource Name (ARN) of the stream whose retention period you want to change.
  - setStreamARN
```
public void setStreamARN(java.lang.String streamARN)
```
    The Amazon Resource Name (ARN) of the stream whose retention period you want to change.
    
    Constraints:
    Length: 1 - 1024
    Pattern: arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
    
    Parameters:
    
    streamARN -
    The Amazon Resource Name (ARN) of the stream whose retention period you want to change.
  - withStreamARN
```
public UpdateDataRetentionRequest withStreamARN(java.lang.String streamARN)
```
    The Amazon Resource Name (ARN) of the stream whose retention period you want to change.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 1024
    Pattern: arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+
    
    Parameters:
    
    streamARN -
    The Amazon Resource Name (ARN) of the stream whose retention period you want to change.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getCurrentVersion
```
public java.lang.String getCurrentVersion()
```
    The version of the stream whose retention period you want to change. To get the version, call either the DescribeStream or the ListStreams API.
    
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9]+
    
    Returns:
    
    The version of the stream whose retention period you want to change. To get the version, call either the DescribeStream or the ListStreams API.
  - setCurrentVersion
```
public void setCurrentVersion(java.lang.String currentVersion)
```
    The version of the stream whose retention period you want to change. To get the version, call either the DescribeStream or the ListStreams API.
    
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9]+
    
    Parameters:
    
    currentVersion -
    The version of the stream whose retention period you want to change. To get the version, call either the DescribeStream or the ListStreams API.
  - withCurrentVersion
```
public UpdateDataRetentionRequest withCurrentVersion(java.lang.String currentVersion)
```
    The version of the stream whose retention period you want to change. To get the version, call either the DescribeStream or the ListStreams API.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 64
    Pattern: [a-zA-Z0-9]+
    
    Parameters:
    
    currentVersion -
    The version of the stream whose retention period you want to change. To get the version, call either the DescribeStream or the ListStreams API.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getOperation
```
public java.lang.String getOperation()
```
    Indicates whether you want to increase or decrease the retention period.
    
    Constraints:
    Allowed Values: INCREASE_DATA_RETENTION, DECREASE_DATA_RETENTION
    
    Returns:
    
    Indicates whether you want to increase or decrease the retention period.
    
    See Also:
    
    UpdateDataRetentionOperation
  - setOperation
```
public void setOperation(java.lang.String operation)
```
    Indicates whether you want to increase or decrease the retention period.
    
    Constraints:
    Allowed Values: INCREASE_DATA_RETENTION, DECREASE_DATA_RETENTION
    
    Parameters:
    
    operation -
    Indicates whether you want to increase or decrease the retention period.
    
    See Also:
    
    UpdateDataRetentionOperation
  - withOperation
```
public UpdateDataRetentionRequest withOperation(java.lang.String operation)
```
    Indicates whether you want to increase or decrease the retention period.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: INCREASE_DATA_RETENTION, DECREASE_DATA_RETENTION
    
    Parameters:
    
    operation -
    Indicates whether you want to increase or decrease the retention period.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    UpdateDataRetentionOperation
  - setOperation
```
public void setOperation(UpdateDataRetentionOperation operation)
```
    Indicates whether you want to increase or decrease the retention period.
    
    Constraints:
    Allowed Values: INCREASE_DATA_RETENTION, DECREASE_DATA_RETENTION
    
    Parameters:
    
    operation -
    Indicates whether you want to increase or decrease the retention period.
    
    See Also:
    
    UpdateDataRetentionOperation
  - withOperation
```
public UpdateDataRetentionRequest withOperation(UpdateDataRetentionOperation operation)
```
    Indicates whether you want to increase or decrease the retention period.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: INCREASE_DATA_RETENTION, DECREASE_DATA_RETENTION
    
    Parameters:
    
    operation -
    Indicates whether you want to increase or decrease the retention period.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    UpdateDataRetentionOperation
  - getDataRetentionChangeInHours
```
public java.lang.Integer getDataRetentionChangeInHours()
```
    The retention period, in hours. The value you specify replaces the current value. The maximum value for this parameter is 87600 (ten years).
    
    Constraints:
    Range: 1 -
    
    Returns:
    
    The retention period, in hours. The value you specify replaces the current value. The maximum value for this parameter is 87600 (ten years).
  - setDataRetentionChangeInHours
```
public void setDataRetentionChangeInHours(java.lang.Integer dataRetentionChangeInHours)
```
    The retention period, in hours. The value you specify replaces the current value. The maximum value for this parameter is 87600 (ten years).
    
    Constraints:
    Range: 1 -
    
    Parameters:
    
    dataRetentionChangeInHours -
    The retention period, in hours. The value you specify replaces the current value. The maximum value for this parameter is 87600 (ten years).
  - withDataRetentionChangeInHours
```
public UpdateDataRetentionRequest withDataRetentionChangeInHours(java.lang.Integer dataRetentionChangeInHours)
```
    The retention period, in hours. The value you specify replaces the current value. The maximum value for this parameter is 87600 (ten years).
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 -
    
    Parameters:
    
    dataRetentionChangeInHours -
    The retention period, in hours. The value you specify replaces the current value. The maximum value for this parameter is 87600 (ten years).
    
    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

Class UpdateDataRetentionRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

UpdateDataRetentionRequest

Method Detail

getStreamName

setStreamName

withStreamName

getStreamARN

setStreamARN

withStreamARN

getCurrentVersion

setCurrentVersion

withCurrentVersion

getOperation

setOperation

withOperation

setOperation

withOperation

getDataRetentionChangeInHours

setDataRetentionChangeInHours

withDataRetentionChangeInHours

toString

hashCode

equals