AWS SDK for C++  1.9.104
AWS SDK for C++
DescribeJobExecutionRequest.h
Go to the documentation of this file.
1 
6 #pragma once
7 #include <aws/iot/IoT_EXPORTS.h>
8 #include <aws/iot/IoTRequest.h>
10 #include <utility>
11 
12 namespace Aws
13 {
14 namespace Http
15 {
16  class URI;
17 } //namespace Http
18 namespace IoT
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 "DescribeJobExecution"; }
35 
36  Aws::String SerializePayload() const override;
37 
38  void AddQueryStringParameters(Aws::Http::URI& uri) const override;
39 
40 
44  inline const Aws::String& GetJobId() const{ return m_jobId; }
45 
49  inline bool JobIdHasBeenSet() const { return m_jobIdHasBeenSet; }
50 
54  inline void SetJobId(const Aws::String& value) { m_jobIdHasBeenSet = true; m_jobId = value; }
55 
59  inline void SetJobId(Aws::String&& value) { m_jobIdHasBeenSet = true; m_jobId = std::move(value); }
60 
64  inline void SetJobId(const char* value) { m_jobIdHasBeenSet = true; m_jobId.assign(value); }
65 
69  inline DescribeJobExecutionRequest& WithJobId(const Aws::String& value) { SetJobId(value); return *this;}
70 
74  inline DescribeJobExecutionRequest& WithJobId(Aws::String&& value) { SetJobId(std::move(value)); return *this;}
75 
79  inline DescribeJobExecutionRequest& WithJobId(const char* value) { SetJobId(value); return *this;}
80 
81 
85  inline const Aws::String& GetThingName() const{ return m_thingName; }
86 
90  inline bool ThingNameHasBeenSet() const { return m_thingNameHasBeenSet; }
91 
95  inline void SetThingName(const Aws::String& value) { m_thingNameHasBeenSet = true; m_thingName = value; }
96 
100  inline void SetThingName(Aws::String&& value) { m_thingNameHasBeenSet = true; m_thingName = std::move(value); }
101 
105  inline void SetThingName(const char* value) { m_thingNameHasBeenSet = true; m_thingName.assign(value); }
106 
110  inline DescribeJobExecutionRequest& WithThingName(const Aws::String& value) { SetThingName(value); return *this;}
111 
115  inline DescribeJobExecutionRequest& WithThingName(Aws::String&& value) { SetThingName(std::move(value)); return *this;}
116 
120  inline DescribeJobExecutionRequest& WithThingName(const char* value) { SetThingName(value); return *this;}
121 
122 
127  inline long long GetExecutionNumber() const{ return m_executionNumber; }
128 
133  inline bool ExecutionNumberHasBeenSet() const { return m_executionNumberHasBeenSet; }
134 
139  inline void SetExecutionNumber(long long value) { m_executionNumberHasBeenSet = true; m_executionNumber = value; }
140 
145  inline DescribeJobExecutionRequest& WithExecutionNumber(long long value) { SetExecutionNumber(value); return *this;}
146 
147  private:
148 
149  Aws::String m_jobId;
150  bool m_jobIdHasBeenSet;
151 
152  Aws::String m_thingName;
153  bool m_thingNameHasBeenSet;
154 
155  long long m_executionNumber;
156  bool m_executionNumberHasBeenSet;
157  };
158 
159 } // namespace Model
160 } // namespace IoT
161 } // namespace Aws
Aws::IoT::Model::DescribeJobExecutionRequest::WithExecutionNumber
DescribeJobExecutionRequest & WithExecutionNumber(long long value)
Definition: DescribeJobExecutionRequest.h:145
Aws::IoT::Model::DescribeJobExecutionRequest::DescribeJobExecutionRequest
DescribeJobExecutionRequest()
Aws::Http::URI
Definition: URI.h:32
Aws::IoT::Model::DescribeJobExecutionRequest::WithThingName
DescribeJobExecutionRequest & WithThingName(Aws::String &&value)
Definition: DescribeJobExecutionRequest.h:115
Aws::IoT::Model::DescribeJobExecutionRequest::WithThingName
DescribeJobExecutionRequest & WithThingName(const char *value)
Definition: DescribeJobExecutionRequest.h:120
Aws::IoT::Model::DescribeJobExecutionRequest::SetJobId
void SetJobId(Aws::String &&value)
Definition: DescribeJobExecutionRequest.h:59
Aws::IoT::Model::DescribeJobExecutionRequest::WithJobId
DescribeJobExecutionRequest & WithJobId(const Aws::String &value)
Definition: DescribeJobExecutionRequest.h:69
Aws::IoT::Model::DescribeJobExecutionRequest::SetJobId
void SetJobId(const Aws::String &value)
Definition: DescribeJobExecutionRequest.h:54
Aws::IoT::Model::DescribeJobExecutionRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::IoT::Model::DescribeJobExecutionRequest::ExecutionNumberHasBeenSet
bool ExecutionNumberHasBeenSet() const
Definition: DescribeJobExecutionRequest.h:133
Aws::IoT::Model::DescribeJobExecutionRequest::SetJobId
void SetJobId(const char *value)
Definition: DescribeJobExecutionRequest.h:64
Aws::IoT::Model::DescribeJobExecutionRequest::SetThingName
void SetThingName(Aws::String &&value)
Definition: DescribeJobExecutionRequest.h:100
Aws::IoT::Model::DescribeJobExecutionRequest::ThingNameHasBeenSet
bool ThingNameHasBeenSet() const
Definition: DescribeJobExecutionRequest.h:90
Aws::IoT::Model::DescribeJobExecutionRequest::SetThingName
void SetThingName(const char *value)
Definition: DescribeJobExecutionRequest.h:105
Aws::IoT::Model::DescribeJobExecutionRequest::SetThingName
void SetThingName(const Aws::String &value)
Definition: DescribeJobExecutionRequest.h:95
AWSString.h
Aws::IoT::IoTRequest
Definition: IoTRequest.h:17
Aws::IoT::Model::DescribeJobExecutionRequest::GetJobId
const Aws::String & GetJobId() const
Definition: DescribeJobExecutionRequest.h:44
Aws::IoT::Model::DescribeJobExecutionRequest::WithJobId
DescribeJobExecutionRequest & WithJobId(const char *value)
Definition: DescribeJobExecutionRequest.h:79
Aws::IoT::Model::DescribeJobExecutionRequest::WithJobId
DescribeJobExecutionRequest & WithJobId(Aws::String &&value)
Definition: DescribeJobExecutionRequest.h:74
Aws::IoT::Model::DescribeJobExecutionRequest
Definition: DescribeJobExecutionRequest.h:26
Aws
Definition: AccessManagementClient.h:15
Aws::IoT::Model::DescribeJobExecutionRequest::AddQueryStringParameters
void AddQueryStringParameters(Aws::Http::URI &uri) const override
Aws::IoT::Model::DescribeJobExecutionRequest::GetThingName
const Aws::String & GetThingName() const
Definition: DescribeJobExecutionRequest.h:85
AWS_IOT_API
#define AWS_IOT_API
Definition: IoT_EXPORTS.h:28
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::IoT::Model::DescribeJobExecutionRequest::SetExecutionNumber
void SetExecutionNumber(long long value)
Definition: DescribeJobExecutionRequest.h:139
IoTRequest.h
Aws::IoT::Model::DescribeJobExecutionRequest::JobIdHasBeenSet
bool JobIdHasBeenSet() const
Definition: DescribeJobExecutionRequest.h:49
Aws::IoT::Model::DescribeJobExecutionRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: DescribeJobExecutionRequest.h:34
Aws::IoT::Model::DescribeJobExecutionRequest::GetExecutionNumber
long long GetExecutionNumber() const
Definition: DescribeJobExecutionRequest.h:127
IoT_EXPORTS.h
Aws::IoT::Model::DescribeJobExecutionRequest::WithThingName
DescribeJobExecutionRequest & WithThingName(const Aws::String &value)
Definition: DescribeJobExecutionRequest.h:110