com.amazonaws.services.kinesis.model

Class DeleteStreamRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesis.model.DeleteStreamRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DeleteStreamRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DeleteStream operation.

Deletes a stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it will receive the exception ResourceNotFoundException .

If the stream is in the ACTIVE state, you can delete it. After a DeleteStream request, the specified stream is in the DELETING state until Amazon Kinesis completes the deletion.

Note: Amazon Kinesis might continue to accept data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the DELETING state until the stream deletion is complete.

When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.

You can use the DescribeStream operation to check the state of the stream, which is returned in StreamStatus .

DeleteStream has a limit of 5 transactions per second per account.

See Also:

AmazonKinesis.deleteStream(DeleteStreamRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DeleteStreamRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DeleteStreamRequest	clone()
boolean	equals(Object obj)
String	getStreamName() The name of the stream to delete.
int	hashCode()
void	setStreamName(String streamName) The name of the stream to delete.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DeleteStreamRequest	withStreamName(String streamName) The name of the stream to delete.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeleteStreamRequest

public DeleteStreamRequest()

Method Detail

getStreamName

public String getStreamName()

The name of the stream to delete.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Returns:

The name of the stream to delete.

setStreamName

public void setStreamName(String streamName)

The name of the stream to delete.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Parameters:

streamName - The name of the stream to delete.

withStreamName

public DeleteStreamRequest withStreamName(String streamName)

The name of the stream to delete.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Parameters:

streamName - The name of the stream to delete.

Returns:

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

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DeleteStreamRequest clone()

Overrides:

clone in class AmazonWebServiceRequest