/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include <aws/kinesis/Kinesis_EXPORTS.h> #include <aws/kinesis/KinesisRequest.h> #include <aws/core/utils/memory/stl/AWSString.h> #include <utility> namespace Aws { namespace Kinesis { namespace Model { /** * <p>Represents the input for <code>DescribeStream</code>.</p><p><h3>See * Also:</h3> <a * href="http://docs.aws.amazon.com/goto/WebAPI/kinesis-2013-12-02/DescribeStreamInput">AWS * API Reference</a></p> */ class AWS_KINESIS_API DescribeStreamRequest : public KinesisRequest { public: DescribeStreamRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "DescribeStream"; } Aws::String SerializePayload() const override; Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** * <p>The name of the stream to describe.</p> */ inline const Aws::String& GetStreamName() const{ return m_streamName; } /** * <p>The name of the stream to describe.</p> */ inline bool StreamNameHasBeenSet() const { return m_streamNameHasBeenSet; } /** * <p>The name of the stream to describe.</p> */ inline void SetStreamName(const Aws::String& value) { m_streamNameHasBeenSet = true; m_streamName = value; } /** * <p>The name of the stream to describe.</p> */ inline void SetStreamName(Aws::String&& value) { m_streamNameHasBeenSet = true; m_streamName = std::move(value); } /** * <p>The name of the stream to describe.</p> */ inline void SetStreamName(const char* value) { m_streamNameHasBeenSet = true; m_streamName.assign(value); } /** * <p>The name of the stream to describe.</p> */ inline DescribeStreamRequest& WithStreamName(const Aws::String& value) { SetStreamName(value); return *this;} /** * <p>The name of the stream to describe.</p> */ inline DescribeStreamRequest& WithStreamName(Aws::String&& value) { SetStreamName(std::move(value)); return *this;} /** * <p>The name of the stream to describe.</p> */ inline DescribeStreamRequest& WithStreamName(const char* value) { SetStreamName(value); return *this;} /** * <p>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.</p> */ inline int GetLimit() const{ return m_limit; } /** * <p>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.</p> */ inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; } /** * <p>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.</p> */ inline void SetLimit(int value) { m_limitHasBeenSet = true; m_limit = value; } /** * <p>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.</p> */ inline DescribeStreamRequest& WithLimit(int value) { SetLimit(value); return *this;} /** * <p>The shard ID of the shard to start with.</p> */ inline const Aws::String& GetExclusiveStartShardId() const{ return m_exclusiveStartShardId; } /** * <p>The shard ID of the shard to start with.</p> */ inline bool ExclusiveStartShardIdHasBeenSet() const { return m_exclusiveStartShardIdHasBeenSet; } /** * <p>The shard ID of the shard to start with.</p> */ inline void SetExclusiveStartShardId(const Aws::String& value) { m_exclusiveStartShardIdHasBeenSet = true; m_exclusiveStartShardId = value; } /** * <p>The shard ID of the shard to start with.</p> */ inline void SetExclusiveStartShardId(Aws::String&& value) { m_exclusiveStartShardIdHasBeenSet = true; m_exclusiveStartShardId = std::move(value); } /** * <p>The shard ID of the shard to start with.</p> */ inline void SetExclusiveStartShardId(const char* value) { m_exclusiveStartShardIdHasBeenSet = true; m_exclusiveStartShardId.assign(value); } /** * <p>The shard ID of the shard to start with.</p> */ inline DescribeStreamRequest& WithExclusiveStartShardId(const Aws::String& value) { SetExclusiveStartShardId(value); return *this;} /** * <p>The shard ID of the shard to start with.</p> */ inline DescribeStreamRequest& WithExclusiveStartShardId(Aws::String&& value) { SetExclusiveStartShardId(std::move(value)); return *this;} /** * <p>The shard ID of the shard to start with.</p> */ inline DescribeStreamRequest& WithExclusiveStartShardId(const char* value) { SetExclusiveStartShardId(value); return *this;} private: Aws::String m_streamName; bool m_streamNameHasBeenSet; int m_limit; bool m_limitHasBeenSet; Aws::String m_exclusiveStartShardId; bool m_exclusiveStartShardIdHasBeenSet; }; } // namespace Model } // namespace Kinesis } // namespace Aws