com.amazonaws.services.kinesisvideo.model

Class DeleteStreamRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesisvideo.model.DeleteStreamRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class DeleteStreamRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeleteStreamRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getCurrentVersion() Optional: The version of the stream that you want to delete.
java.lang.String	getStreamARN() The Amazon Resource Name (ARN) of the stream that you want to delete.
int	hashCode()
void	setCurrentVersion(java.lang.String currentVersion) Optional: The version of the stream that you want to delete.
void	setStreamARN(java.lang.String streamARN) The Amazon Resource Name (ARN) of the stream that you want to delete.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
DeleteStreamRequest	withCurrentVersion(java.lang.String currentVersion) Optional: The version of the stream that you want to delete.
DeleteStreamRequest	withStreamARN(java.lang.String streamARN) The Amazon Resource Name (ARN) of the stream that you want to delete.

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

DeleteStreamRequest

public DeleteStreamRequest()

Method Detail

getStreamARN

public java.lang.String getStreamARN()

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

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

setStreamARN

public void setStreamARN(java.lang.String streamARN)

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

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

withStreamARN

public DeleteStreamRequest withStreamARN(java.lang.String 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: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 that you want to delete.

Returns:

A reference to this updated object so that method calls can be chained together.

getCurrentVersion

public java.lang.String getCurrentVersion()

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]+

Returns:

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.

setCurrentVersion

public void setCurrentVersion(java.lang.String 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]+

Parameters:

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.

withCurrentVersion

public DeleteStreamRequest withCurrentVersion(java.lang.String 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]+

Parameters:

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