Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   * 
   * Licensed under the Apache License, Version 2.0 (the "License").
   * You may not use this file except in compliance with the License.
   * A copy of the License is located at
   * 
   *  http://aws.amazon.com/apache2.0
   * 
  * or in the "license" file accompanying this file. This file is distributed
  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 package com.amazonaws.services.kinesis.model;
 
 
Container for the parameters to the 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.

 
 public class MergeShardsRequest extends AmazonWebServiceRequest implements SerializableCloneable {

    
The name of the stream for the merge.

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

 
     private String streamName;

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

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

    private String shardToMerge;

    
The shard ID of the adjacent shard for the merge.

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

    private String adjacentShardToMerge;

    
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.
    public String getStreamName() {
        return ;
    }
    
    
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.
    public void setStreamName(String streamName) {
        this. = 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.
    public MergeShardsRequest withStreamName(String streamName) {
        this. = streamName;
        return this;
    }

    
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.
    public String getShardToMerge() {
        return ;
    }
    
    
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.
    public void setShardToMerge(String shardToMerge) {
        this. = 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.
    public MergeShardsRequest withShardToMerge(String shardToMerge) {
        this. = shardToMerge;
        return this;
    }

    
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.
    public String getAdjacentShardToMerge() {
        return ;
    }
    
    
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.
    public void setAdjacentShardToMerge(String adjacentShardToMerge) {
        this. = 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.
    public MergeShardsRequest withAdjacentShardToMerge(String adjacentShardToMerge) {
        this. = adjacentShardToMerge;
        return this;
    }

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

Returns:
A string representation of this object.
See also:
java.lang.Object.toString()
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getStreamName() != nullsb.append("StreamName: " + getStreamName() + ",");
        if (getShardToMerge() != nullsb.append("ShardToMerge: " + getShardToMerge() + ",");
        if (getAdjacentShardToMerge() != nullsb.append("AdjacentShardToMerge: " + getAdjacentShardToMerge() );
        sb.append("}");
        return sb.toString();
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        
        hashCode = prime * hashCode + ((getStreamName() == null) ? 0 : getStreamName().hashCode()); 
        hashCode = prime * hashCode + ((getShardToMerge() == null) ? 0 : getShardToMerge().hashCode()); 
        hashCode = prime * hashCode + ((getAdjacentShardToMerge() == null) ? 0 : getAdjacentShardToMerge().hashCode()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == objreturn true;
        if (obj == nullreturn false;
        if (obj instanceof MergeShardsRequest == falsereturn false;
        MergeShardsRequest other = (MergeShardsRequest)obj;
        
        if (other.getStreamName() == null ^ this.getStreamName() == nullreturn false;
        if (other.getStreamName() != null && other.getStreamName().equals(this.getStreamName()) == falsereturn false
        if (other.getShardToMerge() == null ^ this.getShardToMerge() == nullreturn false;
        if (other.getShardToMerge() != null && other.getShardToMerge().equals(this.getShardToMerge()) == falsereturn false
        if (other.getAdjacentShardToMerge() == null ^ this.getAdjacentShardToMerge() == nullreturn false;
        if (other.getAdjacentShardToMerge() != null && other.getAdjacentShardToMerge().equals(this.getAdjacentShardToMerge()) == falsereturn false
        return true;
    }
    
    @Override
    public MergeShardsRequest clone() {
        
            return (MergeShardsRequestsuper.clone();
    }
}
    
New to GrepCode? Check out our FAQ X