AWS SDK for C++  1.9.40
AWS SDK for C++
SignRequest.h
Go to the documentation of this file.
1 
6 #pragma once
7 #include <aws/kms/KMS_EXPORTS.h>
8 #include <aws/kms/KMSRequest.h>
10 #include <aws/core/utils/Array.h>
14 #include <utility>
15 
16 namespace Aws
17 {
18 namespace KMS
19 {
20 namespace Model
21 {
22 
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 "Sign"; }
35 
36  Aws::String SerializePayload() const override;
37 
39 
40 
57  inline const Aws::String& GetKeyId() const{ return m_keyId; }
58 
75  inline bool KeyIdHasBeenSet() const { return m_keyIdHasBeenSet; }
76 
93  inline void SetKeyId(const Aws::String& value) { m_keyIdHasBeenSet = true; m_keyId = value; }
94 
111  inline void SetKeyId(Aws::String&& value) { m_keyIdHasBeenSet = true; m_keyId = std::move(value); }
112 
129  inline void SetKeyId(const char* value) { m_keyIdHasBeenSet = true; m_keyId.assign(value); }
130 
147  inline SignRequest& WithKeyId(const Aws::String& value) { SetKeyId(value); return *this;}
148 
165  inline SignRequest& WithKeyId(Aws::String&& value) { SetKeyId(std::move(value)); return *this;}
166 
183  inline SignRequest& WithKeyId(const char* value) { SetKeyId(value); return *this;}
184 
185 
192  inline const Aws::Utils::CryptoBuffer& GetMessage() const{ return m_message; }
193 
200  inline bool MessageHasBeenSet() const { return m_messageHasBeenSet; }
201 
208  inline void SetMessage(const Aws::Utils::CryptoBuffer& value) { m_messageHasBeenSet = true; m_message = value; }
209 
216  inline void SetMessage(Aws::Utils::CryptoBuffer&& value) { m_messageHasBeenSet = true; m_message = std::move(value); }
217 
224  inline SignRequest& WithMessage(const Aws::Utils::CryptoBuffer& value) { SetMessage(value); return *this;}
225 
232  inline SignRequest& WithMessage(Aws::Utils::CryptoBuffer&& value) { SetMessage(std::move(value)); return *this;}
233 
234 
240  inline const MessageType& GetMessageType() const{ return m_messageType; }
241 
247  inline bool MessageTypeHasBeenSet() const { return m_messageTypeHasBeenSet; }
248 
254  inline void SetMessageType(const MessageType& value) { m_messageTypeHasBeenSet = true; m_messageType = value; }
255 
261  inline void SetMessageType(MessageType&& value) { m_messageTypeHasBeenSet = true; m_messageType = std::move(value); }
262 
268  inline SignRequest& WithMessageType(const MessageType& value) { SetMessageType(value); return *this;}
269 
275  inline SignRequest& WithMessageType(MessageType&& value) { SetMessageType(std::move(value)); return *this;}
276 
277 
283  inline const Aws::Vector<Aws::String>& GetGrantTokens() const{ return m_grantTokens; }
284 
290  inline bool GrantTokensHasBeenSet() const { return m_grantTokensHasBeenSet; }
291 
297  inline void SetGrantTokens(const Aws::Vector<Aws::String>& value) { m_grantTokensHasBeenSet = true; m_grantTokens = value; }
298 
304  inline void SetGrantTokens(Aws::Vector<Aws::String>&& value) { m_grantTokensHasBeenSet = true; m_grantTokens = std::move(value); }
305 
311  inline SignRequest& WithGrantTokens(const Aws::Vector<Aws::String>& value) { SetGrantTokens(value); return *this;}
312 
318  inline SignRequest& WithGrantTokens(Aws::Vector<Aws::String>&& value) { SetGrantTokens(std::move(value)); return *this;}
319 
325  inline SignRequest& AddGrantTokens(const Aws::String& value) { m_grantTokensHasBeenSet = true; m_grantTokens.push_back(value); return *this; }
326 
332  inline SignRequest& AddGrantTokens(Aws::String&& value) { m_grantTokensHasBeenSet = true; m_grantTokens.push_back(std::move(value)); return *this; }
333 
339  inline SignRequest& AddGrantTokens(const char* value) { m_grantTokensHasBeenSet = true; m_grantTokens.push_back(value); return *this; }
340 
341 
347  inline const SigningAlgorithmSpec& GetSigningAlgorithm() const{ return m_signingAlgorithm; }
348 
354  inline bool SigningAlgorithmHasBeenSet() const { return m_signingAlgorithmHasBeenSet; }
355 
361  inline void SetSigningAlgorithm(const SigningAlgorithmSpec& value) { m_signingAlgorithmHasBeenSet = true; m_signingAlgorithm = value; }
362 
368  inline void SetSigningAlgorithm(SigningAlgorithmSpec&& value) { m_signingAlgorithmHasBeenSet = true; m_signingAlgorithm = std::move(value); }
369 
375  inline SignRequest& WithSigningAlgorithm(const SigningAlgorithmSpec& value) { SetSigningAlgorithm(value); return *this;}
376 
382  inline SignRequest& WithSigningAlgorithm(SigningAlgorithmSpec&& value) { SetSigningAlgorithm(std::move(value)); return *this;}
383 
384  private:
385 
386  Aws::String m_keyId;
387  bool m_keyIdHasBeenSet;
388 
389  Aws::Utils::CryptoBuffer m_message;
390  bool m_messageHasBeenSet;
391 
392  MessageType m_messageType;
393  bool m_messageTypeHasBeenSet;
394 
395  Aws::Vector<Aws::String> m_grantTokens;
396  bool m_grantTokensHasBeenSet;
397 
398  SigningAlgorithmSpec m_signingAlgorithm;
399  bool m_signingAlgorithmHasBeenSet;
400  };
401 
402 } // namespace Model
403 } // namespace KMS
404 } // namespace Aws
Aws::KMS::Model::SignRequest::WithGrantTokens
SignRequest & WithGrantTokens(Aws::Vector< Aws::String > &&value)
Definition: SignRequest.h:318
Aws::KMS::Model::SignRequest::SetGrantTokens
void SetGrantTokens(const Aws::Vector< Aws::String > &value)
Definition: SignRequest.h:297
Aws::KMS::Model::SignRequest
Definition: SignRequest.h:26
Aws::KMS::Model::SignRequest::WithGrantTokens
SignRequest & WithGrantTokens(const Aws::Vector< Aws::String > &value)
Definition: SignRequest.h:311
Aws::KMS::Model::SignRequest::GetKeyId
const Aws::String & GetKeyId() const
Definition: SignRequest.h:57
Aws::KMS::Model::SignRequest::MessageTypeHasBeenSet
bool MessageTypeHasBeenSet() const
Definition: SignRequest.h:247
Aws::Http::HeaderValueCollection
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
Definition: HttpTypes.h:53
Aws::KMS::Model::SignRequest::AddGrantTokens
SignRequest & AddGrantTokens(const Aws::String &value)
Definition: SignRequest.h:325
Aws::KMS::Model::SignRequest::WithMessage
SignRequest & WithMessage(Aws::Utils::CryptoBuffer &&value)
Definition: SignRequest.h:232
Aws::KMS::Model::SignRequest::KeyIdHasBeenSet
bool KeyIdHasBeenSet() const
Definition: SignRequest.h:75
Aws::KMS::Model::SignRequest::SignRequest
SignRequest()
Aws::KMS::Model::SignRequest::GetRequestSpecificHeaders
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
Aws::KMS::Model::SignRequest::MessageHasBeenSet
bool MessageHasBeenSet() const
Definition: SignRequest.h:200
Aws::KMS::Model::SignRequest::SigningAlgorithmHasBeenSet
bool SigningAlgorithmHasBeenSet() const
Definition: SignRequest.h:354
Aws::Vector
std::vector< T, Aws::Allocator< T > > Vector
Definition: AWSVector.h:17
Aws::KMS::Model::MessageType
MessageType
Definition: MessageType.h:17
Aws::KMS::Model::SignRequest::AddGrantTokens
SignRequest & AddGrantTokens(Aws::String &&value)
Definition: SignRequest.h:332
SigningAlgorithmSpec.h
Aws::KMS::Model::SignRequest::SetMessage
void SetMessage(const Aws::Utils::CryptoBuffer &value)
Definition: SignRequest.h:208
Aws::KMS::Model::SignRequest::WithSigningAlgorithm
SignRequest & WithSigningAlgorithm(const SigningAlgorithmSpec &value)
Definition: SignRequest.h:375
AWSVector.h
Aws::KMS::Model::SignRequest::GetMessage
const Aws::Utils::CryptoBuffer & GetMessage() const
Definition: SignRequest.h:192
KMSRequest.h
Aws::KMS::Model::SignRequest::GetSigningAlgorithm
const SigningAlgorithmSpec & GetSigningAlgorithm() const
Definition: SignRequest.h:347
Aws::KMS::Model::SignRequest::GrantTokensHasBeenSet
bool GrantTokensHasBeenSet() const
Definition: SignRequest.h:290
Aws::KMS::Model::SignRequest::WithMessageType
SignRequest & WithMessageType(MessageType &&value)
Definition: SignRequest.h:275
Aws::KMS::Model::SignRequest::GetMessageType
const MessageType & GetMessageType() const
Definition: SignRequest.h:240
Aws::KMS::Model::SignRequest::SetKeyId
void SetKeyId(const char *value)
Definition: SignRequest.h:129
Aws::KMS::KMSRequest
Definition: KMSRequest.h:17
Aws::KMS::Model::SignRequest::SetMessage
void SetMessage(Aws::Utils::CryptoBuffer &&value)
Definition: SignRequest.h:216
Aws::KMS::Model::SignRequest::AddGrantTokens
SignRequest & AddGrantTokens(const char *value)
Definition: SignRequest.h:339
Aws::KMS::Model::SignRequest::SetSigningAlgorithm
void SetSigningAlgorithm(SigningAlgorithmSpec &&value)
Definition: SignRequest.h:368
Aws::KMS::Model::SignRequest::GetGrantTokens
const Aws::Vector< Aws::String > & GetGrantTokens() const
Definition: SignRequest.h:283
AWS_KMS_API
#define AWS_KMS_API
Definition: KMS_EXPORTS.h:28
Aws::KMS::Model::SignRequest::WithMessageType
SignRequest & WithMessageType(const MessageType &value)
Definition: SignRequest.h:268
Aws::KMS::Model::SignRequest::SetKeyId
void SetKeyId(const Aws::String &value)
Definition: SignRequest.h:93
Aws::KMS::Model::SignRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: SignRequest.h:34
Aws::KMS::Model::SigningAlgorithmSpec
SigningAlgorithmSpec
Definition: SigningAlgorithmSpec.h:17
AWSString.h
Aws::KMS::Model::SignRequest::WithMessage
SignRequest & WithMessage(const Aws::Utils::CryptoBuffer &value)
Definition: SignRequest.h:224
Aws::KMS::Model::SignRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::KMS::Model::SignRequest::SetSigningAlgorithm
void SetSigningAlgorithm(const SigningAlgorithmSpec &value)
Definition: SignRequest.h:361
Aws::KMS::Model::SignRequest::WithKeyId
SignRequest & WithKeyId(const Aws::String &value)
Definition: SignRequest.h:147
Aws::CodePipeline::Model::EncryptionKeyType::NOT_SET
@ NOT_SET
Aws::Utils::CryptoBuffer
Definition: Array.h:229
MessageType.h
Aws
Definition: AccessManagementClient.h:15
Aws::KMS::Model::SignRequest::WithKeyId
SignRequest & WithKeyId(Aws::String &&value)
Definition: SignRequest.h:165
Array.h
KMS_EXPORTS.h
Aws::KMS::Model::SignRequest::WithKeyId
SignRequest & WithKeyId(const char *value)
Definition: SignRequest.h:183
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::KMS::Model::SignRequest::SetKeyId
void SetKeyId(Aws::String &&value)
Definition: SignRequest.h:111
Aws::KMS::Model::SignRequest::SetGrantTokens
void SetGrantTokens(Aws::Vector< Aws::String > &&value)
Definition: SignRequest.h:304
Aws::KMS::Model::SignRequest::WithSigningAlgorithm
SignRequest & WithSigningAlgorithm(SigningAlgorithmSpec &&value)
Definition: SignRequest.h:382
Aws::KMS::Model::SignRequest::SetMessageType
void SetMessageType(const MessageType &value)
Definition: SignRequest.h:254
Aws::KMS::Model::SignRequest::SetMessageType
void SetMessageType(MessageType &&value)
Definition: SignRequest.h:261