AWS SDK for C++  1.9.103
AWS SDK for C++
DescribeStreamRequest.h
Go to the documentation of this file.
1 
6 #pragma once
10 #include <utility>
11 
12 namespace Aws
13 {
14 namespace Kinesis
15 {
16 namespace Model
17 {
18 
26  {
27  public:
29 
30  // Service request name is the Operation name which will send this request out,
31  // each operation should has unique request name, so that we can get operation's name from this request.
32  // Note: this is not true for response, multiple operations may have the same response name,
33  // so we can not get operation's name from response.
34  inline virtual const char* GetServiceRequestName() const override { return "DescribeStream"; }
35 
36  Aws::String SerializePayload() const override;
37 
39 
40 
44  inline const Aws::String& GetStreamName() const{ return m_streamName; }
45 
49  inline bool StreamNameHasBeenSet() const { return m_streamNameHasBeenSet; }
50 
54  inline void SetStreamName(const Aws::String& value) { m_streamNameHasBeenSet = true; m_streamName = value; }
55 
59  inline void SetStreamName(Aws::String&& value) { m_streamNameHasBeenSet = true; m_streamName = std::move(value); }
60 
64  inline void SetStreamName(const char* value) { m_streamNameHasBeenSet = true; m_streamName.assign(value); }
65 
69  inline DescribeStreamRequest& WithStreamName(const Aws::String& value) { SetStreamName(value); return *this;}
70 
74  inline DescribeStreamRequest& WithStreamName(Aws::String&& value) { SetStreamName(std::move(value)); return *this;}
75 
79  inline DescribeStreamRequest& WithStreamName(const char* value) { SetStreamName(value); return *this;}
80 
81 
87  inline int GetLimit() const{ return m_limit; }
88 
94  inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; }
95 
101  inline void SetLimit(int value) { m_limitHasBeenSet = true; m_limit = value; }
102 
108  inline DescribeStreamRequest& WithLimit(int value) { SetLimit(value); return *this;}
109 
110 
114  inline const Aws::String& GetExclusiveStartShardId() const{ return m_exclusiveStartShardId; }
115 
119  inline bool ExclusiveStartShardIdHasBeenSet() const { return m_exclusiveStartShardIdHasBeenSet; }
120 
124  inline void SetExclusiveStartShardId(const Aws::String& value) { m_exclusiveStartShardIdHasBeenSet = true; m_exclusiveStartShardId = value; }
125 
129  inline void SetExclusiveStartShardId(Aws::String&& value) { m_exclusiveStartShardIdHasBeenSet = true; m_exclusiveStartShardId = std::move(value); }
130 
134  inline void SetExclusiveStartShardId(const char* value) { m_exclusiveStartShardIdHasBeenSet = true; m_exclusiveStartShardId.assign(value); }
135 
139  inline DescribeStreamRequest& WithExclusiveStartShardId(const Aws::String& value) { SetExclusiveStartShardId(value); return *this;}
140 
144  inline DescribeStreamRequest& WithExclusiveStartShardId(Aws::String&& value) { SetExclusiveStartShardId(std::move(value)); return *this;}
145 
149  inline DescribeStreamRequest& WithExclusiveStartShardId(const char* value) { SetExclusiveStartShardId(value); return *this;}
150 
151  private:
152 
153  Aws::String m_streamName;
154  bool m_streamNameHasBeenSet;
155 
156  int m_limit;
157  bool m_limitHasBeenSet;
158 
159  Aws::String m_exclusiveStartShardId;
160  bool m_exclusiveStartShardIdHasBeenSet;
161  };
162 
163 } // namespace Model
164 } // namespace Kinesis
165 } // namespace Aws
Aws::Kinesis::Model::DescribeStreamRequest::WithExclusiveStartShardId
DescribeStreamRequest & WithExclusiveStartShardId(const char *value)
Definition: DescribeStreamRequest.h:149
Aws::Kinesis::Model::DescribeStreamRequest::ExclusiveStartShardIdHasBeenSet
bool ExclusiveStartShardIdHasBeenSet() const
Definition: DescribeStreamRequest.h:119
Aws::Kinesis::Model::DescribeStreamRequest::WithLimit
DescribeStreamRequest & WithLimit(int value)
Definition: DescribeStreamRequest.h:108
Aws::Http::HeaderValueCollection
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
Definition: HttpTypes.h:53
Aws::Kinesis::Model::DescribeStreamRequest::SetExclusiveStartShardId
void SetExclusiveStartShardId(const char *value)
Definition: DescribeStreamRequest.h:134
Aws::Kinesis::Model::DescribeStreamRequest::DescribeStreamRequest
DescribeStreamRequest()
AWS_KINESIS_API
#define AWS_KINESIS_API
Definition: Kinesis_EXPORTS.h:28
KinesisRequest.h
Aws::Kinesis::Model::DescribeStreamRequest::WithStreamName
DescribeStreamRequest & WithStreamName(const Aws::String &value)
Definition: DescribeStreamRequest.h:69
Aws::Kinesis::Model::DescribeStreamRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::Kinesis::Model::DescribeStreamRequest::StreamNameHasBeenSet
bool StreamNameHasBeenSet() const
Definition: DescribeStreamRequest.h:49
Aws::Kinesis::Model::DescribeStreamRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: DescribeStreamRequest.h:34
Aws::Kinesis::Model::DescribeStreamRequest::WithStreamName
DescribeStreamRequest & WithStreamName(const char *value)
Definition: DescribeStreamRequest.h:79
AWSString.h
Aws::Kinesis::KinesisRequest
Definition: KinesisRequest.h:17
Aws::Kinesis::Model::DescribeStreamRequest::SetLimit
void SetLimit(int value)
Definition: DescribeStreamRequest.h:101
Aws::Kinesis::Model::DescribeStreamRequest::SetStreamName
void SetStreamName(Aws::String &&value)
Definition: DescribeStreamRequest.h:59
Aws::Kinesis::Model::DescribeStreamRequest::LimitHasBeenSet
bool LimitHasBeenSet() const
Definition: DescribeStreamRequest.h:94
Aws::Kinesis::Model::DescribeStreamRequest::SetExclusiveStartShardId
void SetExclusiveStartShardId(Aws::String &&value)
Definition: DescribeStreamRequest.h:129
Kinesis_EXPORTS.h
Aws::Kinesis::Model::DescribeStreamRequest::GetExclusiveStartShardId
const Aws::String & GetExclusiveStartShardId() const
Definition: DescribeStreamRequest.h:114
Aws::Kinesis::Model::DescribeStreamRequest::GetStreamName
const Aws::String & GetStreamName() const
Definition: DescribeStreamRequest.h:44
Aws::Kinesis::Model::DescribeStreamRequest::GetRequestSpecificHeaders
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
Aws
Definition: AccessManagementClient.h:15
Aws::Kinesis::Model::DescribeStreamRequest::SetExclusiveStartShardId
void SetExclusiveStartShardId(const Aws::String &value)
Definition: DescribeStreamRequest.h:124
Aws::Kinesis::Model::DescribeStreamRequest::WithExclusiveStartShardId
DescribeStreamRequest & WithExclusiveStartShardId(Aws::String &&value)
Definition: DescribeStreamRequest.h:144
Aws::Kinesis::Model::DescribeStreamRequest::WithStreamName
DescribeStreamRequest & WithStreamName(Aws::String &&value)
Definition: DescribeStreamRequest.h:74
Aws::Kinesis::Model::DescribeStreamRequest::SetStreamName
void SetStreamName(const char *value)
Definition: DescribeStreamRequest.h:64
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::Kinesis::Model::DescribeStreamRequest::GetLimit
int GetLimit() const
Definition: DescribeStreamRequest.h:87
Aws::Kinesis::Model::DescribeStreamRequest::WithExclusiveStartShardId
DescribeStreamRequest & WithExclusiveStartShardId(const Aws::String &value)
Definition: DescribeStreamRequest.h:139
Aws::Kinesis::Model::DescribeStreamRequest
Definition: DescribeStreamRequest.h:26
Aws::Kinesis::Model::DescribeStreamRequest::SetStreamName
void SetStreamName(const Aws::String &value)
Definition: DescribeStreamRequest.h:54