com.amazonaws.services.kinesis.model.SplitShardRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kinesis Show documentation
/*
* Copyright 2019-2024 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;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Represents the input for SplitShard.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SplitShardRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the stream for the shard split.
*
*/
private String streamName;
/**
*
* The shard ID of the shard to split.
*
*/
private String shardToSplit;
/**
*
* A hash key value for the starting hash key of one of the child shards created by the split. The hash key range
* for a given shard constitutes a set of ordered contiguous positive integers. The value for
* NewStartingHashKey must be in the range of hash keys being mapped into the shard. The
* NewStartingHashKey hash key value and all higher hash key values in hash key range are distributed
* to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.
*
*/
private String newStartingHashKey;
/**
*
* The ARN of the stream.
*
*/
private String streamARN;
/**
*
* The name of the stream for the shard split.
*
*
* @param streamName
* The name of the stream for the shard split.
*/
public void setStreamName(String streamName) {
this.streamName = streamName;
}
/**
*
* The name of the stream for the shard split.
*
*
* @return The name of the stream for the shard split.
*/
public String getStreamName() {
return this.streamName;
}
/**
*
* The name of the stream for the shard split.
*
*
* @param streamName
* The name of the stream for the shard split.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SplitShardRequest withStreamName(String streamName) {
setStreamName(streamName);
return this;
}
/**
*
* The shard ID of the shard to split.
*
*
* @param shardToSplit
* The shard ID of the shard to split.
*/
public void setShardToSplit(String shardToSplit) {
this.shardToSplit = shardToSplit;
}
/**
*
* The shard ID of the shard to split.
*
*
* @return The shard ID of the shard to split.
*/
public String getShardToSplit() {
return this.shardToSplit;
}
/**
*
* The shard ID of the shard to split.
*
*
* @param shardToSplit
* The shard ID of the shard to split.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SplitShardRequest withShardToSplit(String shardToSplit) {
setShardToSplit(shardToSplit);
return this;
}
/**
*
* A hash key value for the starting hash key of one of the child shards created by the split. The hash key range
* for a given shard constitutes a set of ordered contiguous positive integers. The value for
* NewStartingHashKey must be in the range of hash keys being mapped into the shard. The
* NewStartingHashKey hash key value and all higher hash key values in hash key range are distributed
* to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.
*
*
* @param newStartingHashKey
* A hash key value for the starting hash key of one of the child shards created by the split. The hash key
* range for a given shard constitutes a set of ordered contiguous positive integers. The value for
* NewStartingHashKey must be in the range of hash keys being mapped into the shard. The
* NewStartingHashKey hash key value and all higher hash key values in hash key range are
* distributed to one of the child shards. All the lower hash key values in the range are distributed to the
* other child shard.
*/
public void setNewStartingHashKey(String newStartingHashKey) {
this.newStartingHashKey = newStartingHashKey;
}
/**
*
* A hash key value for the starting hash key of one of the child shards created by the split. The hash key range
* for a given shard constitutes a set of ordered contiguous positive integers. The value for
* NewStartingHashKey must be in the range of hash keys being mapped into the shard. The
* NewStartingHashKey hash key value and all higher hash key values in hash key range are distributed
* to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.
*
*
* @return A hash key value for the starting hash key of one of the child shards created by the split. The hash key
* range for a given shard constitutes a set of ordered contiguous positive integers. The value for
* NewStartingHashKey must be in the range of hash keys being mapped into the shard. The
* NewStartingHashKey hash key value and all higher hash key values in hash key range are
* distributed to one of the child shards. All the lower hash key values in the range are distributed to the
* other child shard.
*/
public String getNewStartingHashKey() {
return this.newStartingHashKey;
}
/**
*
* A hash key value for the starting hash key of one of the child shards created by the split. The hash key range
* for a given shard constitutes a set of ordered contiguous positive integers. The value for
* NewStartingHashKey must be in the range of hash keys being mapped into the shard. The
* NewStartingHashKey hash key value and all higher hash key values in hash key range are distributed
* to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.
*
*
* @param newStartingHashKey
* A hash key value for the starting hash key of one of the child shards created by the split. The hash key
* range for a given shard constitutes a set of ordered contiguous positive integers. The value for
* NewStartingHashKey must be in the range of hash keys being mapped into the shard. The
* NewStartingHashKey hash key value and all higher hash key values in hash key range are
* distributed to one of the child shards. All the lower hash key values in the range are distributed to the
* other child shard.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SplitShardRequest withNewStartingHashKey(String newStartingHashKey) {
setNewStartingHashKey(newStartingHashKey);
return this;
}
/**
*
* The ARN of the stream.
*
*
* @param streamARN
* The ARN of the stream.
*/
public void setStreamARN(String streamARN) {
this.streamARN = streamARN;
}
/**
*
* The ARN of the stream.
*
*
* @return The ARN of the stream.
*/
public String getStreamARN() {
return this.streamARN;
}
/**
*
* The ARN of the stream.
*
*
* @param streamARN
* The ARN of the stream.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SplitShardRequest withStreamARN(String streamARN) {
setStreamARN(streamARN);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getStreamName() != null)
sb.append("StreamName: ").append(getStreamName()).append(",");
if (getShardToSplit() != null)
sb.append("ShardToSplit: ").append(getShardToSplit()).append(",");
if (getNewStartingHashKey() != null)
sb.append("NewStartingHashKey: ").append(getNewStartingHashKey()).append(",");
if (getStreamARN() != null)
sb.append("StreamARN: ").append(getStreamARN());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SplitShardRequest == false)
return false;
SplitShardRequest other = (SplitShardRequest) obj;
if (other.getStreamName() == null ^ this.getStreamName() == null)
return false;
if (other.getStreamName() != null && other.getStreamName().equals(this.getStreamName()) == false)
return false;
if (other.getShardToSplit() == null ^ this.getShardToSplit() == null)
return false;
if (other.getShardToSplit() != null && other.getShardToSplit().equals(this.getShardToSplit()) == false)
return false;
if (other.getNewStartingHashKey() == null ^ this.getNewStartingHashKey() == null)
return false;
if (other.getNewStartingHashKey() != null && other.getNewStartingHashKey().equals(this.getNewStartingHashKey()) == false)
return false;
if (other.getStreamARN() == null ^ this.getStreamARN() == null)
return false;
if (other.getStreamARN() != null && other.getStreamARN().equals(this.getStreamARN()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getStreamName() == null) ? 0 : getStreamName().hashCode());
hashCode = prime * hashCode + ((getShardToSplit() == null) ? 0 : getShardToSplit().hashCode());
hashCode = prime * hashCode + ((getNewStartingHashKey() == null) ? 0 : getNewStartingHashKey().hashCode());
hashCode = prime * hashCode + ((getStreamARN() == null) ? 0 : getStreamARN().hashCode());
return hashCode;
}
@Override
public SplitShardRequest clone() {
return (SplitShardRequest) super.clone();
}
}