/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.kinesisvideo.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* 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: *

* */ public class UpdateDataRetentionRequest extends AmazonWebServiceRequest implements Serializable { /** *

* The name of the stream whose retention period you want to change. *

*

* Constraints:
* Length: 1 - 256
* Pattern: [a-zA-Z0-9_.-]+
*/ private String streamName; /** *

* The Amazon Resource Name (ARN) of the stream whose retention period you * want to change. *

*

* Constraints:
* Length: 1 - 1024
* Pattern: * arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- * Z0-9_.-]+/[0-9]+
*/ private String streamARN; /** *

* 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]+
*/ private String currentVersion; /** *

* Indicates whether you want to increase or decrease the retention period. *

*

* Constraints:
* Allowed Values: INCREASE_DATA_RETENTION, DECREASE_DATA_RETENTION */ private String operation; /** *

* 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 -
*/ private Integer dataRetentionChangeInHours; /** *

* The name of the stream whose retention period you want to change. *

*

* Constraints:
* Length: 1 - 256
* Pattern: [a-zA-Z0-9_.-]+
* * @return

* The name of the stream whose retention period you want to change. *

*/ public String getStreamName() { return streamName; } /** *

* The name of the stream whose retention period you want to change. *

*

* Constraints:
* Length: 1 - 256
* Pattern: [a-zA-Z0-9_.-]+
* * @param streamName

* The name of the stream whose retention period you want to * change. *

*/ public void setStreamName(String streamName) { this.streamName = 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_.-]+
* * @param streamName

* The name of the stream whose retention period you want to * change. *

* @return A reference to this updated object so that method calls can be * chained together. */ public UpdateDataRetentionRequest withStreamName(String streamName) { this.streamName = streamName; return this; } /** *

* The Amazon Resource Name (ARN) of the stream whose retention period you * want to change. *

*

* Constraints:
* Length: 1 - 1024
* Pattern: * arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- * Z0-9_.-]+/[0-9]+
* * @return

* The Amazon Resource Name (ARN) of the stream whose retention * period you want to change. *

*/ public String getStreamARN() { return streamARN; } /** *

* The Amazon Resource Name (ARN) of the stream whose retention period you * want to change. *

*

* Constraints:
* Length: 1 - 1024
* Pattern: * arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- * Z0-9_.-]+/[0-9]+
* * @param streamARN

* The Amazon Resource Name (ARN) of the stream whose retention * period you want to change. *

*/ public void setStreamARN(String streamARN) { this.streamARN = 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:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA- * Z0-9_.-]+/[0-9]+
* * @param streamARN

* The Amazon Resource Name (ARN) of the stream whose retention * period you want to change. *

* @return A reference to this updated object so that method calls can be * chained together. */ public UpdateDataRetentionRequest withStreamARN(String streamARN) { this.streamARN = streamARN; return this; } /** *

* 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]+
* * @return

* The version of the stream whose retention period you want to * change. To get the version, call either the * DescribeStream or the ListStreams API. *

*/ public String getCurrentVersion() { return 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]+
* * @param 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. *

*/ public void setCurrentVersion(String currentVersion) { this.currentVersion = 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]+
* * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public UpdateDataRetentionRequest withCurrentVersion(String currentVersion) { this.currentVersion = currentVersion; return this; } /** *

* Indicates whether you want to increase or decrease the retention period. *

*

* Constraints:
* Allowed Values: INCREASE_DATA_RETENTION, DECREASE_DATA_RETENTION * * @return

* Indicates whether you want to increase or decrease the retention * period. *

* @see UpdateDataRetentionOperation */ public String getOperation() { return operation; } /** *

* Indicates whether you want to increase or decrease the retention period. *

*

* Constraints:
* Allowed Values: INCREASE_DATA_RETENTION, DECREASE_DATA_RETENTION * * @param operation

* Indicates whether you want to increase or decrease the * retention period. *

* @see UpdateDataRetentionOperation */ public void setOperation(String operation) { this.operation = 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 * * @param operation

* Indicates whether you want to increase or decrease the * retention period. *

* @return A reference to this updated object so that method calls can be * chained together. * @see UpdateDataRetentionOperation */ public UpdateDataRetentionRequest withOperation(String operation) { this.operation = operation; return this; } /** *

* Indicates whether you want to increase or decrease the retention period. *

*

* Constraints:
* Allowed Values: INCREASE_DATA_RETENTION, DECREASE_DATA_RETENTION * * @param operation

* Indicates whether you want to increase or decrease the * retention period. *

* @see UpdateDataRetentionOperation */ public void setOperation(UpdateDataRetentionOperation operation) { this.operation = operation.toString(); } /** *

* 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 * * @param operation

* Indicates whether you want to increase or decrease the * retention period. *

* @return A reference to this updated object so that method calls can be * chained together. * @see UpdateDataRetentionOperation */ public UpdateDataRetentionRequest withOperation(UpdateDataRetentionOperation operation) { this.operation = operation.toString(); return this; } /** *

* 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 -
* * @return

* The retention period, in hours. The value you specify replaces * the current value. The maximum value for this parameter is 87600 * (ten years). *

*/ public Integer getDataRetentionChangeInHours() { return 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 -
* * @param dataRetentionChangeInHours

* The retention period, in hours. The value you specify replaces * the current value. The maximum value for this parameter is * 87600 (ten years). *

*/ public void setDataRetentionChangeInHours(Integer dataRetentionChangeInHours) { this.dataRetentionChangeInHours = 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 -
* * @param dataRetentionChangeInHours

* The retention period, in hours. The value you specify replaces * the current value. The maximum value for this parameter is * 87600 (ten years). *

* @return A reference to this updated object so that method calls can be * chained together. */ public UpdateDataRetentionRequest withDataRetentionChangeInHours( Integer dataRetentionChangeInHours) { this.dataRetentionChangeInHours = dataRetentionChangeInHours; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getStreamName() != null) sb.append("StreamName: " + getStreamName() + ","); if (getStreamARN() != null) sb.append("StreamARN: " + getStreamARN() + ","); if (getCurrentVersion() != null) sb.append("CurrentVersion: " + getCurrentVersion() + ","); if (getOperation() != null) sb.append("Operation: " + getOperation() + ","); if (getDataRetentionChangeInHours() != null) sb.append("DataRetentionChangeInHours: " + getDataRetentionChangeInHours()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getStreamName() == null) ? 0 : getStreamName().hashCode()); hashCode = prime * hashCode + ((getStreamARN() == null) ? 0 : getStreamARN().hashCode()); hashCode = prime * hashCode + ((getCurrentVersion() == null) ? 0 : getCurrentVersion().hashCode()); hashCode = prime * hashCode + ((getOperation() == null) ? 0 : getOperation().hashCode()); hashCode = prime * hashCode + ((getDataRetentionChangeInHours() == null) ? 0 : getDataRetentionChangeInHours() .hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof UpdateDataRetentionRequest == false) return false; UpdateDataRetentionRequest other = (UpdateDataRetentionRequest) obj; if (other.getStreamName() == null ^ this.getStreamName() == null) return false; if (other.getStreamName() != null && other.getStreamName().equals(this.getStreamName()) == false) return false; if (other.getStreamARN() == null ^ this.getStreamARN() == null) return false; if (other.getStreamARN() != null && other.getStreamARN().equals(this.getStreamARN()) == false) return false; if (other.getCurrentVersion() == null ^ this.getCurrentVersion() == null) return false; if (other.getCurrentVersion() != null && other.getCurrentVersion().equals(this.getCurrentVersion()) == false) return false; if (other.getOperation() == null ^ this.getOperation() == null) return false; if (other.getOperation() != null && other.getOperation().equals(this.getOperation()) == false) return false; if (other.getDataRetentionChangeInHours() == null ^ this.getDataRetentionChangeInHours() == null) return false; if (other.getDataRetentionChangeInHours() != null && other.getDataRetentionChangeInHours().equals( this.getDataRetentionChangeInHours()) == false) return false; return true; } }