/* * 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; /** *

* Deletes a Kinesis video stream and the data contained in the stream. *

*

* This method marks the stream for deletion, and makes the data in the stream * inaccessible immediately. *

*

*

*

* To ensure that you have the latest version of the stream before deleting it, * you can specify the stream version. Kinesis Video Streams assigns a version * to each stream. When you update a stream, Kinesis Video Streams assigns a new * version number. To get the latest stream version, use the * DescribeStream API. *

*

* This operation requires permission for the * KinesisVideo:DeleteStream action. *

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

* The Amazon Resource Name (ARN) of the stream that you want to delete. *

*

* 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; /** *

* Optional: The version of the stream that you want to delete. *

*

* Specify the version as a safeguard to ensure that your are deleting the * correct stream. To get the stream version, use the * DescribeStream API. *

*

* If not specified, only the CreationTime is checked before * deleting the stream. *

*

* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9]+
*/ private String currentVersion; /** *

* The Amazon Resource Name (ARN) of the stream that you want to delete. *

*

* 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 that you want to * delete. *

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

* The Amazon Resource Name (ARN) of the stream that you want to delete. *

*

* 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 that you want to * delete. *

*/ public void setStreamARN(String streamARN) { this.streamARN = streamARN; } /** *

* The Amazon Resource Name (ARN) of the stream that you want to delete. *

*

* 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 that you want to * delete. *

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

* Optional: The version of the stream that you want to delete. *

*

* Specify the version as a safeguard to ensure that your are deleting the * correct stream. To get the stream version, use the * DescribeStream API. *

*

* If not specified, only the CreationTime is checked before * deleting the stream. *

*

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

* Optional: The version of the stream that you want to delete. *

*

* Specify the version as a safeguard to ensure that your are * deleting the correct stream. To get the stream version, use the * DescribeStream API. *

*

* If not specified, only the CreationTime is checked * before deleting the stream. *

*/ public String getCurrentVersion() { return currentVersion; } /** *

* Optional: The version of the stream that you want to delete. *

*

* Specify the version as a safeguard to ensure that your are deleting the * correct stream. To get the stream version, use the * DescribeStream API. *

*

* If not specified, only the CreationTime is checked before * deleting the stream. *

*

* Constraints:
* Length: 1 - 64
* Pattern: [a-zA-Z0-9]+
* * @param currentVersion

* Optional: The version of the stream that you want to delete. *

*

* Specify the version as a safeguard to ensure that your are * deleting the correct stream. To get the stream version, use * the DescribeStream API. *

*

* If not specified, only the CreationTime is * checked before deleting the stream. *

*/ public void setCurrentVersion(String currentVersion) { this.currentVersion = currentVersion; } /** *

* Optional: The version of the stream that you want to delete. *

*

* Specify the version as a safeguard to ensure that your are deleting the * correct stream. To get the stream version, use the * DescribeStream API. *

*

* If not specified, only the CreationTime is checked before * deleting the stream. *

*

* 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

* Optional: The version of the stream that you want to delete. *

*

* Specify the version as a safeguard to ensure that your are * deleting the correct stream. To get the stream version, use * the DescribeStream API. *

*

* If not specified, only the CreationTime is * checked before deleting the stream. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DeleteStreamRequest withCurrentVersion(String currentVersion) { this.currentVersion = currentVersion; 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 (getStreamARN() != null) sb.append("StreamARN: " + getStreamARN() + ","); if (getCurrentVersion() != null) sb.append("CurrentVersion: " + getCurrentVersion()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getStreamARN() == null) ? 0 : getStreamARN().hashCode()); hashCode = prime * hashCode + ((getCurrentVersion() == null) ? 0 : getCurrentVersion().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DeleteStreamRequest == false) return false; DeleteStreamRequest other = (DeleteStreamRequest) obj; 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; return true; } }