/* * Copyright 2010-2019 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; /** *

* Describes the specified Kinesis data stream. *

*

* The information returned includes the stream name, Amazon Resource Name * (ARN), creation time, enhanced metric configuration, and shard map. The shard * map is an array of shard objects. For each shard object, there is the hash * key and sequence number ranges that the shard spans, and the IDs of any * earlier shards that played in a role in creating the shard. Every record * ingested in the stream is identified by a sequence number, which is assigned * when the record is put into the stream. *

*

* You can limit the number of shards returned by each call. For more * information, see Retrieving Shards from a Stream in the Amazon Kinesis Data Streams * Developer Guide. *

*

* There are no guarantees about the chronological order shards returned. To * process shards in chronological order, use the ID of the parent shard to * track the lineage to the oldest shard. *

*

* This operation has a limit of 10 transactions per second per account. *

*/ public class DescribeStreamRequest extends AmazonWebServiceRequest implements Serializable { /** *

* The name of the stream to describe. *

*

* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9_.-]+
*/ 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 shards * are returned. *

*

* Constraints:
* Range: 1 - 10000
*/ private Integer limit; /** *

* The shard ID of the shard to start with. *

*

* Constraints:
* Length: 1 - 128
* Pattern: [a-zA-Z0-9_.-]+
*/ private String exclusiveStartShardId; /** *

* The name of the stream to describe. *

*

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

* The name of the stream to describe. *

*/ public String getStreamName() { return streamName; } /** *

* The name of the stream to describe. *

*

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

* The name of the stream to describe. *

*/ public void setStreamName(String streamName) { this.streamName = streamName; } /** *

* The name of the stream to describe. *

*

* 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

* The name of the stream to describe. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DescribeStreamRequest withStreamName(String streamName) { this.streamName = 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 shards * are returned. *

*

* Constraints:
* Range: 1 - 10000
* * @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 shards are returned. *

*/ public Integer getLimit() { return 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 shards * are returned. *

*

* Constraints:
* Range: 1 - 10000
* * @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 shards 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 shards * are returned. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Range: 1 - 10000
* * @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 shards are returned. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DescribeStreamRequest withLimit(Integer limit) { this.limit = limit; return this; } /** *

* The shard ID of the shard to start with. *

*

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

* The shard ID of the shard to start with. *

*/ public String getExclusiveStartShardId() { return exclusiveStartShardId; } /** *

* The shard ID of the shard to start with. *

*

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

* The shard ID of the shard to start with. *

*/ public void setExclusiveStartShardId(String exclusiveStartShardId) { this.exclusiveStartShardId = exclusiveStartShardId; } /** *

* The shard ID of the shard to start with. *

*

* Returns a reference to this object so that method calls can be chained * together. *

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

* The shard ID of the shard to start with. *

* @return A reference to this updated object so that method calls can be * chained together. */ public DescribeStreamRequest withExclusiveStartShardId(String exclusiveStartShardId) { this.exclusiveStartShardId = exclusiveStartShardId; 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 (getLimit() != null) sb.append("Limit: " + getLimit() + ","); if (getExclusiveStartShardId() != null) sb.append("ExclusiveStartShardId: " + getExclusiveStartShardId()); 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 + ((getLimit() == null) ? 0 : getLimit().hashCode()); hashCode = prime * hashCode + ((getExclusiveStartShardId() == null) ? 0 : getExclusiveStartShardId().hashCode()); return hashCode; } @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; return true; } }