com.amazonaws.services.kinesis.model

Class MergeShardsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesis.model.MergeShardsRequest

All Implemented Interfaces:

Serializable

public class MergeShardsRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the MergeShards operation.

This 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. The operation requires that you specify the shard to be merged and the adjacent shard for a given stream. For more information about merging shards, see the Amazon Kinesis Developer Guide .

If the stream is in the ACTIVE state, you can call MergeShards . If a stream is in CREATING or UPDATING or DELETING states, then Amazon Kinesis returns a ResourceInUseException . If the specified stream does not exist, Amazon Kinesis returns a ResourceNotFoundException .

You can use the DescribeStream operation 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 the DescribeStream operation 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.

See Also:

AmazonKinesis.mergeShards(MergeShardsRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
MergeShardsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MergeShardsRequest

public MergeShardsRequest()

Method Detail

getStreamName

public String getStreamName()

The name of the stream for the merge.

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

Returns:

The name of the stream for the merge.

setStreamName

public void setStreamName(String streamName)

The name of the stream for the merge.

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

Parameters:

streamName - The name of the stream for the merge.

withStreamName

public MergeShardsRequest withStreamName(String streamName)

The name of the stream for the merge.

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 for the merge.

Returns:

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

getShardToMerge

public String getShardToMerge()

The shard ID of the shard to combine with the adjacent shard for the merge.

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

Returns:

The shard ID of the shard to combine with the adjacent shard for the merge.

setShardToMerge

public void setShardToMerge(String shardToMerge)

The shard ID of the shard to combine with the adjacent shard for the merge.

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

Parameters:

shardToMerge - The shard ID of the shard to combine with the adjacent shard for the merge.

withShardToMerge

public MergeShardsRequest withShardToMerge(String shardToMerge)

The shard ID of the shard to combine with the adjacent shard for the merge.

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

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

Parameters:

shardToMerge - The shard ID of the shard to combine with the adjacent shard for the merge.

Returns:

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

getAdjacentShardToMerge

public String getAdjacentShardToMerge()

The shard ID of the adjacent shard for the merge.

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

Returns:

The shard ID of the adjacent shard for the merge.

setAdjacentShardToMerge

public void setAdjacentShardToMerge(String adjacentShardToMerge)

The shard ID of the adjacent shard for the merge.

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

Parameters:

adjacentShardToMerge - The shard ID of the adjacent shard for the merge.

withAdjacentShardToMerge

public MergeShardsRequest withAdjacentShardToMerge(String adjacentShardToMerge)

The shard ID of the adjacent shard for the merge.

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

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

Parameters:

adjacentShardToMerge - The shard ID of the adjacent shard for the merge.

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