com.amazonaws.services.kinesis.model.CreateStreamRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 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 com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.kinesis.AmazonKinesis#createStream(CreateStreamRequest) CreateStream operation}.
*
* This operation adds a new Amazon Kinesis stream to your AWS account. A
* stream captures and transports data records that are continuously
* emitted from different data sources or producers .
* Scale-out within an Amazon Kinesis stream is explicitly
* supported by means of shards, which are uniquely identified groups of
* data records in an Amazon Kinesis stream.
*
*
* You specify and control the number of shards that a stream is composed
* of. Each open shard can support up to 5 read transactions per second,
* up to a maximum total of 2 MB of data read per second. Each shard can
* support up to 1000 write transactions per second, up to a maximum
* total of 1 MB data written per second. You can add shards to a stream
* if the amount of data input increases and you can remove shards if the
* amount of data input decreases.
*
*
* The stream name identifies the stream. The name is scoped to the AWS
* account used by the application. It is also scoped by region. That is,
* two streams in two different accounts can have the same name, and two
* streams in the same account, but in two different regions, can have
* the same name.
*
*
* CreateStream is an asynchronous operation. Upon
* receiving a CreateStream request, Amazon Kinesis
* immediately returns and sets the stream status to CREATING. After the
* stream is created, Amazon Kinesis sets the stream status to ACTIVE.
* You should perform read and write operations only on an ACTIVE stream.
*
*
* You receive a LimitExceededException when making a
* CreateStream request if you try to do one of the
* following:
*
*
*
* - Have more than five streams in the CREATING state at any point in
* time.
* - Create more shards than are authorized for your account.
*
*
*
* Note: The default limit for an AWS account is 10 shards per
* stream. If you need to create a stream with more than 10 shards,
* contact AWS Support
* to increase the limit on your account.
*
*
* You can use the DescribeStream operation to check the
* stream status, which is returned in StreamStatus .
*
*
* CreateStream has a limit of 5 transactions per second
* per account.
*
*
* @see com.amazonaws.services.kinesis.AmazonKinesis#createStream(CreateStreamRequest)
*/
public class CreateStreamRequest extends AmazonWebServiceRequest implements Serializable {
/**
* A name to identify the stream. The stream name is scoped to the AWS
* account used by the application that creates the stream. It is also
* scoped by region. That is, two streams in two different AWS accounts
* can have the same name, and two streams in the same AWS account, but
* in two different regions, can have the same name.
*
* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9_.-]+
*/
private String streamName;
/**
* The number of shards that the stream will use. The throughput of the
* stream is a function of the number of shards; more shards are required
* for greater provisioned throughput.
Note: The default limit
* for an AWS account is 10 shards per stream. If you need to create a
* stream with more than 10 shards, contact
* AWS Support to increase the limit on your account.
*
* Constraints:
* Range: 1 -
*/
private Integer shardCount;
/**
* A name to identify the stream. The stream name is scoped to the AWS
* account used by the application that creates the stream. It is also
* scoped by region. That is, two streams in two different AWS accounts
* can have the same name, and two streams in the same AWS account, but
* in two different regions, can have the same name.
*
* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9_.-]+
*
* @return A name to identify the stream. The stream name is scoped to the AWS
* account used by the application that creates the stream. It is also
* scoped by region. That is, two streams in two different AWS accounts
* can have the same name, and two streams in the same AWS account, but
* in two different regions, can have the same name.
*/
public String getStreamName() {
return streamName;
}
/**
* A name to identify the stream. The stream name is scoped to the AWS
* account used by the application that creates the stream. It is also
* scoped by region. That is, two streams in two different AWS accounts
* can have the same name, and two streams in the same AWS account, but
* in two different regions, can have the same name.
*
* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9_.-]+
*
* @param streamName A name to identify the stream. The stream name is scoped to the AWS
* account used by the application that creates the stream. It is also
* scoped by region. That is, two streams in two different AWS accounts
* can have the same name, and two streams in the same AWS account, but
* in two different regions, can have the same name.
*/
public void setStreamName(String streamName) {
this.streamName = streamName;
}
/**
* A name to identify the stream. The stream name is scoped to the AWS
* account used by the application that creates the stream. It is also
* scoped by region. That is, two streams in two different AWS accounts
* can have the same name, and two streams in the same AWS account, but
* in two different regions, can have the same name.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9_.-]+
*
* @param streamName A name to identify the stream. The stream name is scoped to the AWS
* account used by the application that creates the stream. It is also
* scoped by region. That is, two streams in two different AWS accounts
* can have the same name, and two streams in the same AWS account, but
* in two different regions, can have the same name.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateStreamRequest withStreamName(String streamName) {
this.streamName = streamName;
return this;
}
/**
* The number of shards that the stream will use. The throughput of the
* stream is a function of the number of shards; more shards are required
* for greater provisioned throughput.
Note: The default limit
* for an AWS account is 10 shards per stream. If you need to create a
* stream with more than 10 shards, contact
* AWS Support to increase the limit on your account.
*
* Constraints:
* Range: 1 -
*
* @return The number of shards that the stream will use. The throughput of the
* stream is a function of the number of shards; more shards are required
* for greater provisioned throughput.
Note: The default limit
* for an AWS account is 10 shards per stream. If you need to create a
* stream with more than 10 shards, contact
* AWS Support to increase the limit on your account.
*/
public Integer getShardCount() {
return shardCount;
}
/**
* The number of shards that the stream will use. The throughput of the
* stream is a function of the number of shards; more shards are required
* for greater provisioned throughput.
Note: The default limit
* for an AWS account is 10 shards per stream. If you need to create a
* stream with more than 10 shards, contact
* AWS Support to increase the limit on your account.
*
* Constraints:
* Range: 1 -
*
* @param shardCount The number of shards that the stream will use. The throughput of the
* stream is a function of the number of shards; more shards are required
* for greater provisioned throughput.
Note: The default limit
* for an AWS account is 10 shards per stream. If you need to create a
* stream with more than 10 shards, contact
* AWS Support to increase the limit on your account.
*/
public void setShardCount(Integer shardCount) {
this.shardCount = shardCount;
}
/**
* The number of shards that the stream will use. The throughput of the
* stream is a function of the number of shards; more shards are required
* for greater provisioned throughput.
Note: The default limit
* for an AWS account is 10 shards per stream. If you need to create a
* stream with more than 10 shards, contact
* AWS Support to increase the limit on your account.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Range: 1 -
*
* @param shardCount The number of shards that the stream will use. The throughput of the
* stream is a function of the number of shards; more shards are required
* for greater provisioned throughput.
Note: The default limit
* for an AWS account is 10 shards per stream. If you need to create a
* stream with more than 10 shards, contact
* AWS Support to increase the limit on your account.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateStreamRequest withShardCount(Integer shardCount) {
this.shardCount = shardCount;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @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: " + getStreamName() + ",");
if (getShardCount() != null) sb.append("ShardCount: " + getShardCount() );
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 + ((getShardCount() == null) ? 0 : getShardCount().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof CreateStreamRequest == false) return false;
CreateStreamRequest other = (CreateStreamRequest)obj;
if (other.getStreamName() == null ^ this.getStreamName() == null) return false;
if (other.getStreamName() != null && other.getStreamName().equals(this.getStreamName()) == false) return false;
if (other.getShardCount() == null ^ this.getShardCount() == null) return false;
if (other.getShardCount() != null && other.getShardCount().equals(this.getShardCount()) == false) return false;
return true;
}
}