/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Kinesis { namespace Model { /** *

Represents the input for DescribeStream.

See * Also:

AWS * API Reference

*/ 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; /** *

The name of the stream to describe.

*/ inline const Aws::String& GetStreamName() const{ return m_streamName; } /** *

The name of the stream to describe.

*/ inline bool StreamNameHasBeenSet() const { return m_streamNameHasBeenSet; } /** *

The name of the stream to describe.

*/ inline void SetStreamName(const Aws::String& value) { m_streamNameHasBeenSet = true; m_streamName = value; } /** *

The name of the stream to describe.

*/ inline void SetStreamName(Aws::String&& value) { m_streamNameHasBeenSet = true; m_streamName = std::move(value); } /** *

The name of the stream to describe.

*/ inline void SetStreamName(const char* value) { m_streamNameHasBeenSet = true; m_streamName.assign(value); } /** *

The name of the stream to describe.

*/ inline DescribeStreamRequest& WithStreamName(const Aws::String& value) { SetStreamName(value); return *this;} /** *

The name of the stream to describe.

*/ inline DescribeStreamRequest& WithStreamName(Aws::String&& value) { SetStreamName(std::move(value)); return *this;} /** *

The name of the stream to describe.

*/ inline DescribeStreamRequest& WithStreamName(const char* value) { SetStreamName(value); 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.

*/ inline int GetLimit() const{ return m_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.

*/ inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; } /** *

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.

*/ inline void SetLimit(int value) { m_limitHasBeenSet = true; m_limit = value; } /** *

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.

*/ inline DescribeStreamRequest& WithLimit(int value) { SetLimit(value); return *this;} /** *

The shard ID of the shard to start with.

*/ inline const Aws::String& GetExclusiveStartShardId() const{ return m_exclusiveStartShardId; } /** *

The shard ID of the shard to start with.

*/ inline bool ExclusiveStartShardIdHasBeenSet() const { return m_exclusiveStartShardIdHasBeenSet; } /** *

The shard ID of the shard to start with.

*/ inline void SetExclusiveStartShardId(const Aws::String& value) { m_exclusiveStartShardIdHasBeenSet = true; m_exclusiveStartShardId = value; } /** *

The shard ID of the shard to start with.

*/ inline void SetExclusiveStartShardId(Aws::String&& value) { m_exclusiveStartShardIdHasBeenSet = true; m_exclusiveStartShardId = std::move(value); } /** *

The shard ID of the shard to start with.

*/ inline void SetExclusiveStartShardId(const char* value) { m_exclusiveStartShardIdHasBeenSet = true; m_exclusiveStartShardId.assign(value); } /** *

The shard ID of the shard to start with.

*/ inline DescribeStreamRequest& WithExclusiveStartShardId(const Aws::String& value) { SetExclusiveStartShardId(value); return *this;} /** *

The shard ID of the shard to start with.

*/ inline DescribeStreamRequest& WithExclusiveStartShardId(Aws::String&& value) { SetExclusiveStartShardId(std::move(value)); return *this;} /** *

The shard ID of the shard to start with.

*/ 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