com.amazonaws.services.kinesis.model.CreateStreamRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kinesis Show documentation
/*
* Copyright 2018-2023 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 CreateStream.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateStreamRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A name to identify the stream. The stream name is scoped to the Amazon Web Services account used by the
* application that creates the stream. It is also scoped by Amazon Web Services Region. That is, two streams in two
* different Amazon Web Services accounts can have the same name. Two streams in the same Amazon Web Services
* account but in two different Regions can also have the same name.
*
*/
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.
*
*/
private Integer shardCount;
/**
*
* Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can choose between an
* on-demand capacity mode and a provisioned capacity mode for your data streams.
*
*/
private StreamModeDetails streamModeDetails;
/**
*
* A name to identify the stream. The stream name is scoped to the Amazon Web Services account used by the
* application that creates the stream. It is also scoped by Amazon Web Services Region. That is, two streams in two
* different Amazon Web Services accounts can have the same name. Two streams in the same Amazon Web Services
* account but in two different Regions can also have the same name.
*
*
* @param streamName
* A name to identify the stream. The stream name is scoped to the Amazon Web Services account used by the
* application that creates the stream. It is also scoped by Amazon Web Services Region. That is, two streams
* in two different Amazon Web Services accounts can have the same name. Two streams in the same Amazon Web
* Services account but in two different Regions can also 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 Amazon Web Services account used by the
* application that creates the stream. It is also scoped by Amazon Web Services Region. That is, two streams in two
* different Amazon Web Services accounts can have the same name. Two streams in the same Amazon Web Services
* account but in two different Regions can also have the same name.
*
*
* @return A name to identify the stream. The stream name is scoped to the Amazon Web Services account used by the
* application that creates the stream. It is also scoped by Amazon Web Services Region. That is, two
* streams in two different Amazon Web Services accounts can have the same name. Two streams in the same
* Amazon Web Services account but in two different Regions can also have the same name.
*/
public String getStreamName() {
return this.streamName;
}
/**
*
* A name to identify the stream. The stream name is scoped to the Amazon Web Services account used by the
* application that creates the stream. It is also scoped by Amazon Web Services Region. That is, two streams in two
* different Amazon Web Services accounts can have the same name. Two streams in the same Amazon Web Services
* account but in two different Regions can also have the same name.
*
*
* @param streamName
* A name to identify the stream. The stream name is scoped to the Amazon Web Services account used by the
* application that creates the stream. It is also scoped by Amazon Web Services Region. That is, two streams
* in two different Amazon Web Services accounts can have the same name. Two streams in the same Amazon Web
* Services account but in two different Regions can also have the same name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStreamRequest withStreamName(String streamName) {
setStreamName(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.
*
*
* @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.
*/
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.
*
*
* @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.
*/
public Integer getShardCount() {
return this.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.
*
*
* @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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStreamRequest withShardCount(Integer shardCount) {
setShardCount(shardCount);
return this;
}
/**
*
* Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can choose between an
* on-demand capacity mode and a provisioned capacity mode for your data streams.
*
*
* @param streamModeDetails
* Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can choose between
* an on-demand capacity mode and a provisioned capacity mode for your data streams.
*/
public void setStreamModeDetails(StreamModeDetails streamModeDetails) {
this.streamModeDetails = streamModeDetails;
}
/**
*
* Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can choose between an
* on-demand capacity mode and a provisioned capacity mode for your data streams.
*
*
* @return Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can choose
* between an on-demand capacity mode and a provisioned capacity mode for your data streams.
*/
public StreamModeDetails getStreamModeDetails() {
return this.streamModeDetails;
}
/**
*
* Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can choose between an
* on-demand capacity mode and a provisioned capacity mode for your data streams.
*
*
* @param streamModeDetails
* Indicates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can choose between
* an on-demand capacity mode and a provisioned capacity mode for your data streams.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateStreamRequest withStreamModeDetails(StreamModeDetails streamModeDetails) {
setStreamModeDetails(streamModeDetails);
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 (getShardCount() != null)
sb.append("ShardCount: ").append(getShardCount()).append(",");
if (getStreamModeDetails() != null)
sb.append("StreamModeDetails: ").append(getStreamModeDetails());
sb.append("}");
return sb.toString();
}
@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;
if (other.getStreamModeDetails() == null ^ this.getStreamModeDetails() == null)
return false;
if (other.getStreamModeDetails() != null && other.getStreamModeDetails().equals(this.getStreamModeDetails()) == 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 + ((getShardCount() == null) ? 0 : getShardCount().hashCode());
hashCode = prime * hashCode + ((getStreamModeDetails() == null) ? 0 : getStreamModeDetails().hashCode());
return hashCode;
}
@Override
public CreateStreamRequest clone() {
return (CreateStreamRequest) super.clone();
}
}