public class MergeShardsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
MergeShards operation
.
Merges two adjacent shards in a stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards.
MergeShards
is called when there is a need to reduce the
overall capacity of a stream because of excess capacity that is not
being used. You must specify the shard to be merged and the adjacent
shard for a stream. For more information about merging shards, see
Merge Two Shards
in the Amazon Kinesis Developer Guide .
If the stream is in the ACTIVE
state, you can call
MergeShards
.
If a stream is in the CREATING
,
UPDATING
, or DELETING
state, MergeShards
returns a
ResourceInUseException
. If the specified stream does not
exist, MergeShards
returns a
ResourceNotFoundException
.
You can use DescribeStream to check the state of the stream, which is
returned in StreamStatus
.
MergeShards
is an asynchronous operation. Upon receiving
a MergeShards
request, Amazon Kinesis immediately returns
a response and sets the StreamStatus
to
UPDATING
. After the operation is completed, Amazon
Kinesis sets the StreamStatus
to ACTIVE
.
Read and write operations continue to work while the stream is in the
UPDATING
state.
You use DescribeStream to determine the shard IDs that are specified
in the MergeShards
request.
If you try to operate on too many streams in parallel using
CreateStream, DeleteStream, MergeShards
or SplitShard,
you will receive a
LimitExceededException
.
MergeShards
has limit of 5 transactions per second per
account.
NOOP
Constructor and Description |
---|
MergeShardsRequest() |
Modifier and Type | Method and Description |
---|---|
MergeShardsRequest |
clone() |
boolean |
equals(Object obj) |
String |
getAdjacentShardToMerge()
The shard ID of the adjacent shard for the merge.
|
String |
getShardToMerge()
The shard ID of the shard to combine with the adjacent shard for the
merge.
|
String |
getStreamName()
The name of the stream for the merge.
|
int |
hashCode() |
void |
setAdjacentShardToMerge(String adjacentShardToMerge)
The shard ID of the adjacent shard for the merge.
|
void |
setShardToMerge(String shardToMerge)
The shard ID of the shard to combine with the adjacent shard for the
merge.
|
void |
setStreamName(String streamName)
The name of the stream for the merge.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
MergeShardsRequest |
withAdjacentShardToMerge(String adjacentShardToMerge)
The shard ID of the adjacent shard for the merge.
|
MergeShardsRequest |
withShardToMerge(String shardToMerge)
The shard ID of the shard to combine with the adjacent shard for the
merge.
|
MergeShardsRequest |
withStreamName(String streamName)
The name of the stream for the merge.
|
copyBaseTo, 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 for the merge.public MergeShardsRequest 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 for the merge.public String getShardToMerge()
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
public void setShardToMerge(String shardToMerge)
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
shardToMerge
- The shard ID of the shard to combine with the adjacent shard for the
merge.public MergeShardsRequest withShardToMerge(String shardToMerge)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
shardToMerge
- The shard ID of the shard to combine with the adjacent shard for the
merge.public String getAdjacentShardToMerge()
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
public void setAdjacentShardToMerge(String adjacentShardToMerge)
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
adjacentShardToMerge
- The shard ID of the adjacent shard for the merge.public MergeShardsRequest withAdjacentShardToMerge(String adjacentShardToMerge)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+
adjacentShardToMerge
- The shard ID of the adjacent shard for the merge.public String toString()
toString
in class Object
Object.toString()
public MergeShardsRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2015. All rights reserved.