public class DeleteStreamRequest extends AmazonWebServiceRequest implements Serializable
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 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.
NOOP
Constructor and Description |
---|
DeleteStreamRequest() |
Modifier and Type | Method and Description |
---|---|
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.
|
copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public String getStreamName()
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
public void setStreamName(String streamName)
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
streamName
- The name of the stream to delete.public DeleteStreamRequest withStreamName(String streamName)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
streamName
- The name of the stream to delete.public String toString()
toString
in class Object
Object.toString()
Copyright © 2014. All rights reserved.