/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include <aws/dynamodbstreams/DynamoDBStreams_EXPORTS.h> #include <aws/dynamodbstreams/DynamoDBStreamsRequest.h> #include <aws/core/utils/memory/stl/AWSString.h> #include <utility> namespace Aws { namespace DynamoDBStreams { namespace Model { /** * <p>Represents the input of a <code>DescribeStream</code> * operation.</p><p><h3>See Also:</h3> <a * href="http://docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/DescribeStreamInput">AWS * API Reference</a></p> */ class DescribeStreamRequest : public DynamoDBStreamsRequest { public: AWS_DYNAMODBSTREAMS_API 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_DYNAMODBSTREAMS_API Aws::String SerializePayload() const override; AWS_DYNAMODBSTREAMS_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** * <p>The Amazon Resource Name (ARN) for the stream.</p> */ inline const Aws::String& GetStreamArn() const{ return m_streamArn; } /** * <p>The Amazon Resource Name (ARN) for the stream.</p> */ inline bool StreamArnHasBeenSet() const { return m_streamArnHasBeenSet; } /** * <p>The Amazon Resource Name (ARN) for the stream.</p> */ inline void SetStreamArn(const Aws::String& value) { m_streamArnHasBeenSet = true; m_streamArn = value; } /** * <p>The Amazon Resource Name (ARN) for the stream.</p> */ inline void SetStreamArn(Aws::String&& value) { m_streamArnHasBeenSet = true; m_streamArn = std::move(value); } /** * <p>The Amazon Resource Name (ARN) for the stream.</p> */ inline void SetStreamArn(const char* value) { m_streamArnHasBeenSet = true; m_streamArn.assign(value); } /** * <p>The Amazon Resource Name (ARN) for the stream.</p> */ inline DescribeStreamRequest& WithStreamArn(const Aws::String& value) { SetStreamArn(value); return *this;} /** * <p>The Amazon Resource Name (ARN) for the stream.</p> */ inline DescribeStreamRequest& WithStreamArn(Aws::String&& value) { SetStreamArn(std::move(value)); return *this;} /** * <p>The Amazon Resource Name (ARN) for the stream.</p> */ inline DescribeStreamRequest& WithStreamArn(const char* value) { SetStreamArn(value); return *this;} /** * <p>The maximum number of shard objects to return. The upper limit is 100.</p> */ inline int GetLimit() const{ return m_limit; } /** * <p>The maximum number of shard objects to return. The upper limit is 100.</p> */ inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; } /** * <p>The maximum number of shard objects to return. The upper limit is 100.</p> */ inline void SetLimit(int value) { m_limitHasBeenSet = true; m_limit = value; } /** * <p>The maximum number of shard objects to return. The upper limit is 100.</p> */ inline DescribeStreamRequest& WithLimit(int value) { SetLimit(value); return *this;} /** * <p>The shard ID of the first item that this operation will evaluate. Use the * value that was returned for <code>LastEvaluatedShardId</code> in the previous * operation. </p> */ inline const Aws::String& GetExclusiveStartShardId() const{ return m_exclusiveStartShardId; } /** * <p>The shard ID of the first item that this operation will evaluate. Use the * value that was returned for <code>LastEvaluatedShardId</code> in the previous * operation. </p> */ inline bool ExclusiveStartShardIdHasBeenSet() const { return m_exclusiveStartShardIdHasBeenSet; } /** * <p>The shard ID of the first item that this operation will evaluate. Use the * value that was returned for <code>LastEvaluatedShardId</code> in the previous * operation. </p> */ inline void SetExclusiveStartShardId(const Aws::String& value) { m_exclusiveStartShardIdHasBeenSet = true; m_exclusiveStartShardId = value; } /** * <p>The shard ID of the first item that this operation will evaluate. Use the * value that was returned for <code>LastEvaluatedShardId</code> in the previous * operation. </p> */ inline void SetExclusiveStartShardId(Aws::String&& value) { m_exclusiveStartShardIdHasBeenSet = true; m_exclusiveStartShardId = std::move(value); } /** * <p>The shard ID of the first item that this operation will evaluate. Use the * value that was returned for <code>LastEvaluatedShardId</code> in the previous * operation. </p> */ inline void SetExclusiveStartShardId(const char* value) { m_exclusiveStartShardIdHasBeenSet = true; m_exclusiveStartShardId.assign(value); } /** * <p>The shard ID of the first item that this operation will evaluate. Use the * value that was returned for <code>LastEvaluatedShardId</code> in the previous * operation. </p> */ inline DescribeStreamRequest& WithExclusiveStartShardId(const Aws::String& value) { SetExclusiveStartShardId(value); return *this;} /** * <p>The shard ID of the first item that this operation will evaluate. Use the * value that was returned for <code>LastEvaluatedShardId</code> in the previous * operation. </p> */ inline DescribeStreamRequest& WithExclusiveStartShardId(Aws::String&& value) { SetExclusiveStartShardId(std::move(value)); return *this;} /** * <p>The shard ID of the first item that this operation will evaluate. Use the * value that was returned for <code>LastEvaluatedShardId</code> in the previous * operation. </p> */ inline DescribeStreamRequest& WithExclusiveStartShardId(const char* value) { SetExclusiveStartShardId(value); return *this;} private: Aws::String m_streamArn; bool m_streamArnHasBeenSet = false; int m_limit; bool m_limitHasBeenSet = false; Aws::String m_exclusiveStartShardId; bool m_exclusiveStartShardIdHasBeenSet = false; }; } // namespace Model } // namespace DynamoDBStreams } // namespace Aws