com.amazonaws.services.kinesis.model.DescribeStreamRequest 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 DescribeStream.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeStreamRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the stream to describe.
*
*/
private String streamName;
/**
*
* The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater
* than 100, at most 100 results are returned.
*
*/
private Integer limit;
/**
*
* The shard ID of the shard to start with.
*
*
* Specify this parameter to indicate that you want to describe the stream starting with the shard whose ID
* immediately follows ExclusiveStartShardId.
*
*
* If you don't specify this parameter, the default behavior for DescribeStream is to describe the
* stream starting with the first shard in the stream.
*
*/
private String exclusiveStartShardId;
/**
*
* The ARN of the stream.
*
*/
private String streamARN;
/**
*
* The name of the stream to describe.
*
*
* @param streamName
* The name of the stream to describe.
*/
public void setStreamName(String streamName) {
this.streamName = streamName;
}
/**
*
* The name of the stream to describe.
*
*
* @return The name of the stream to describe.
*/
public String getStreamName() {
return this.streamName;
}
/**
*
* The name of the stream to describe.
*
*
* @param streamName
* The name of the stream to describe.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeStreamRequest withStreamName(String streamName) {
setStreamName(streamName);
return this;
}
/**
*
* The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater
* than 100, at most 100 results are returned.
*
*
* @param limit
* The maximum number of shards to return in a single call. The default value is 100. If you specify a value
* greater than 100, at most 100 results are returned.
*/
public void setLimit(Integer limit) {
this.limit = limit;
}
/**
*
* The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater
* than 100, at most 100 results are returned.
*
*
* @return The maximum number of shards to return in a single call. The default value is 100. If you specify a value
* greater than 100, at most 100 results are returned.
*/
public Integer getLimit() {
return this.limit;
}
/**
*
* The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater
* than 100, at most 100 results are returned.
*
*
* @param limit
* The maximum number of shards to return in a single call. The default value is 100. If you specify a value
* greater than 100, at most 100 results are returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeStreamRequest withLimit(Integer limit) {
setLimit(limit);
return this;
}
/**
*
* The shard ID of the shard to start with.
*
*
* Specify this parameter to indicate that you want to describe the stream starting with the shard whose ID
* immediately follows ExclusiveStartShardId.
*
*
* If you don't specify this parameter, the default behavior for DescribeStream is to describe the
* stream starting with the first shard in the stream.
*
*
* @param exclusiveStartShardId
* The shard ID of the shard to start with.
*
* Specify this parameter to indicate that you want to describe the stream starting with the shard whose ID
* immediately follows ExclusiveStartShardId.
*
*
* If you don't specify this parameter, the default behavior for DescribeStream is to describe
* the stream starting with the first shard in the stream.
*/
public void setExclusiveStartShardId(String exclusiveStartShardId) {
this.exclusiveStartShardId = exclusiveStartShardId;
}
/**
*
* The shard ID of the shard to start with.
*
*
* Specify this parameter to indicate that you want to describe the stream starting with the shard whose ID
* immediately follows ExclusiveStartShardId.
*
*
* If you don't specify this parameter, the default behavior for DescribeStream is to describe the
* stream starting with the first shard in the stream.
*
*
* @return The shard ID of the shard to start with.
*
* Specify this parameter to indicate that you want to describe the stream starting with the shard whose ID
* immediately follows ExclusiveStartShardId.
*
*
* If you don't specify this parameter, the default behavior for DescribeStream is to describe
* the stream starting with the first shard in the stream.
*/
public String getExclusiveStartShardId() {
return this.exclusiveStartShardId;
}
/**
*
* The shard ID of the shard to start with.
*
*
* Specify this parameter to indicate that you want to describe the stream starting with the shard whose ID
* immediately follows ExclusiveStartShardId.
*
*
* If you don't specify this parameter, the default behavior for DescribeStream is to describe the
* stream starting with the first shard in the stream.
*
*
* @param exclusiveStartShardId
* The shard ID of the shard to start with.
*
* Specify this parameter to indicate that you want to describe the stream starting with the shard whose ID
* immediately follows ExclusiveStartShardId.
*
*
* If you don't specify this parameter, the default behavior for DescribeStream is to describe
* the stream starting with the first shard in the stream.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeStreamRequest withExclusiveStartShardId(String exclusiveStartShardId) {
setExclusiveStartShardId(exclusiveStartShardId);
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 DescribeStreamRequest 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 (getLimit() != null)
sb.append("Limit: ").append(getLimit()).append(",");
if (getExclusiveStartShardId() != null)
sb.append("ExclusiveStartShardId: ").append(getExclusiveStartShardId()).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 DescribeStreamRequest == false)
return false;
DescribeStreamRequest other = (DescribeStreamRequest) obj;
if (other.getStreamName() == null ^ this.getStreamName() == null)
return false;
if (other.getStreamName() != null && other.getStreamName().equals(this.getStreamName()) == false)
return false;
if (other.getLimit() == null ^ this.getLimit() == null)
return false;
if (other.getLimit() != null && other.getLimit().equals(this.getLimit()) == false)
return false;
if (other.getExclusiveStartShardId() == null ^ this.getExclusiveStartShardId() == null)
return false;
if (other.getExclusiveStartShardId() != null && other.getExclusiveStartShardId().equals(this.getExclusiveStartShardId()) == 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 + ((getLimit() == null) ? 0 : getLimit().hashCode());
hashCode = prime * hashCode + ((getExclusiveStartShardId() == null) ? 0 : getExclusiveStartShardId().hashCode());
hashCode = prime * hashCode + ((getStreamARN() == null) ? 0 : getStreamARN().hashCode());
return hashCode;
}
@Override
public DescribeStreamRequest clone() {
return (DescribeStreamRequest) super.clone();
}
}