AWS SDK for C++

AWS SDK for C++ Version 1.11.716

Loading...
Searching...
No Matches
Crawler.h
1
6#pragma once
7#include <aws/core/utils/DateTime.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/core/utils/memory/stl/AWSVector.h>
10#include <aws/glue/Glue_EXPORTS.h>
11#include <aws/glue/model/CrawlerState.h>
12#include <aws/glue/model/CrawlerTargets.h>
13#include <aws/glue/model/LakeFormationConfiguration.h>
14#include <aws/glue/model/LastCrawlInfo.h>
15#include <aws/glue/model/LineageConfiguration.h>
16#include <aws/glue/model/RecrawlPolicy.h>
17#include <aws/glue/model/Schedule.h>
18#include <aws/glue/model/SchemaChangePolicy.h>
19
20#include <utility>
21
22namespace Aws {
23namespace Utils {
24namespace Json {
25class JsonValue;
26class JsonView;
27} // namespace Json
28} // namespace Utils
29namespace Glue {
30namespace Model {
31
39class Crawler {
40 public:
41 AWS_GLUE_API Crawler() = default;
42 AWS_GLUE_API Crawler(Aws::Utils::Json::JsonView jsonValue);
45
47
50 inline const Aws::String& GetName() const { return m_name; }
51 inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
52 template <typename NameT = Aws::String>
53 void SetName(NameT&& value) {
54 m_nameHasBeenSet = true;
55 m_name = std::forward<NameT>(value);
56 }
57 template <typename NameT = Aws::String>
58 Crawler& WithName(NameT&& value) {
59 SetName(std::forward<NameT>(value));
60 return *this;
61 }
63
65
69 inline const Aws::String& GetRole() const { return m_role; }
70 inline bool RoleHasBeenSet() const { return m_roleHasBeenSet; }
71 template <typename RoleT = Aws::String>
72 void SetRole(RoleT&& value) {
73 m_roleHasBeenSet = true;
74 m_role = std::forward<RoleT>(value);
75 }
76 template <typename RoleT = Aws::String>
77 Crawler& WithRole(RoleT&& value) {
78 SetRole(std::forward<RoleT>(value));
79 return *this;
80 }
82
84
87 inline const CrawlerTargets& GetTargets() const { return m_targets; }
88 inline bool TargetsHasBeenSet() const { return m_targetsHasBeenSet; }
89 template <typename TargetsT = CrawlerTargets>
90 void SetTargets(TargetsT&& value) {
91 m_targetsHasBeenSet = true;
92 m_targets = std::forward<TargetsT>(value);
93 }
94 template <typename TargetsT = CrawlerTargets>
95 Crawler& WithTargets(TargetsT&& value) {
96 SetTargets(std::forward<TargetsT>(value));
97 return *this;
98 }
100
102
105 inline const Aws::String& GetDatabaseName() const { return m_databaseName; }
106 inline bool DatabaseNameHasBeenSet() const { return m_databaseNameHasBeenSet; }
107 template <typename DatabaseNameT = Aws::String>
108 void SetDatabaseName(DatabaseNameT&& value) {
109 m_databaseNameHasBeenSet = true;
110 m_databaseName = std::forward<DatabaseNameT>(value);
111 }
112 template <typename DatabaseNameT = Aws::String>
113 Crawler& WithDatabaseName(DatabaseNameT&& value) {
114 SetDatabaseName(std::forward<DatabaseNameT>(value));
115 return *this;
116 }
118
120
123 inline const Aws::String& GetDescription() const { return m_description; }
124 inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
125 template <typename DescriptionT = Aws::String>
126 void SetDescription(DescriptionT&& value) {
127 m_descriptionHasBeenSet = true;
128 m_description = std::forward<DescriptionT>(value);
129 }
130 template <typename DescriptionT = Aws::String>
131 Crawler& WithDescription(DescriptionT&& value) {
132 SetDescription(std::forward<DescriptionT>(value));
133 return *this;
134 }
136
138
142 inline const Aws::Vector<Aws::String>& GetClassifiers() const { return m_classifiers; }
143 inline bool ClassifiersHasBeenSet() const { return m_classifiersHasBeenSet; }
144 template <typename ClassifiersT = Aws::Vector<Aws::String>>
145 void SetClassifiers(ClassifiersT&& value) {
146 m_classifiersHasBeenSet = true;
147 m_classifiers = std::forward<ClassifiersT>(value);
148 }
149 template <typename ClassifiersT = Aws::Vector<Aws::String>>
150 Crawler& WithClassifiers(ClassifiersT&& value) {
151 SetClassifiers(std::forward<ClassifiersT>(value));
152 return *this;
153 }
154 template <typename ClassifiersT = Aws::String>
155 Crawler& AddClassifiers(ClassifiersT&& value) {
156 m_classifiersHasBeenSet = true;
157 m_classifiers.emplace_back(std::forward<ClassifiersT>(value));
158 return *this;
159 }
161
163
167 inline const RecrawlPolicy& GetRecrawlPolicy() const { return m_recrawlPolicy; }
168 inline bool RecrawlPolicyHasBeenSet() const { return m_recrawlPolicyHasBeenSet; }
169 template <typename RecrawlPolicyT = RecrawlPolicy>
170 void SetRecrawlPolicy(RecrawlPolicyT&& value) {
171 m_recrawlPolicyHasBeenSet = true;
172 m_recrawlPolicy = std::forward<RecrawlPolicyT>(value);
173 }
174 template <typename RecrawlPolicyT = RecrawlPolicy>
175 Crawler& WithRecrawlPolicy(RecrawlPolicyT&& value) {
176 SetRecrawlPolicy(std::forward<RecrawlPolicyT>(value));
177 return *this;
178 }
180
182
185 inline const SchemaChangePolicy& GetSchemaChangePolicy() const { return m_schemaChangePolicy; }
186 inline bool SchemaChangePolicyHasBeenSet() const { return m_schemaChangePolicyHasBeenSet; }
187 template <typename SchemaChangePolicyT = SchemaChangePolicy>
188 void SetSchemaChangePolicy(SchemaChangePolicyT&& value) {
189 m_schemaChangePolicyHasBeenSet = true;
190 m_schemaChangePolicy = std::forward<SchemaChangePolicyT>(value);
191 }
192 template <typename SchemaChangePolicyT = SchemaChangePolicy>
193 Crawler& WithSchemaChangePolicy(SchemaChangePolicyT&& value) {
194 SetSchemaChangePolicy(std::forward<SchemaChangePolicyT>(value));
195 return *this;
196 }
198
200
204 inline const LineageConfiguration& GetLineageConfiguration() const { return m_lineageConfiguration; }
205 inline bool LineageConfigurationHasBeenSet() const { return m_lineageConfigurationHasBeenSet; }
206 template <typename LineageConfigurationT = LineageConfiguration>
207 void SetLineageConfiguration(LineageConfigurationT&& value) {
208 m_lineageConfigurationHasBeenSet = true;
209 m_lineageConfiguration = std::forward<LineageConfigurationT>(value);
210 }
211 template <typename LineageConfigurationT = LineageConfiguration>
212 Crawler& WithLineageConfiguration(LineageConfigurationT&& value) {
213 SetLineageConfiguration(std::forward<LineageConfigurationT>(value));
214 return *this;
215 }
217
219
222 inline CrawlerState GetState() const { return m_state; }
223 inline bool StateHasBeenSet() const { return m_stateHasBeenSet; }
224 inline void SetState(CrawlerState value) {
225 m_stateHasBeenSet = true;
226 m_state = value;
227 }
229 SetState(value);
230 return *this;
231 }
233
235
238 inline const Aws::String& GetTablePrefix() const { return m_tablePrefix; }
239 inline bool TablePrefixHasBeenSet() const { return m_tablePrefixHasBeenSet; }
240 template <typename TablePrefixT = Aws::String>
241 void SetTablePrefix(TablePrefixT&& value) {
242 m_tablePrefixHasBeenSet = true;
243 m_tablePrefix = std::forward<TablePrefixT>(value);
244 }
245 template <typename TablePrefixT = Aws::String>
246 Crawler& WithTablePrefix(TablePrefixT&& value) {
247 SetTablePrefix(std::forward<TablePrefixT>(value));
248 return *this;
249 }
251
253
256 inline const Schedule& GetSchedule() const { return m_schedule; }
257 inline bool ScheduleHasBeenSet() const { return m_scheduleHasBeenSet; }
258 template <typename ScheduleT = Schedule>
259 void SetSchedule(ScheduleT&& value) {
260 m_scheduleHasBeenSet = true;
261 m_schedule = std::forward<ScheduleT>(value);
262 }
263 template <typename ScheduleT = Schedule>
264 Crawler& WithSchedule(ScheduleT&& value) {
265 SetSchedule(std::forward<ScheduleT>(value));
266 return *this;
267 }
269
271
275 inline long long GetCrawlElapsedTime() const { return m_crawlElapsedTime; }
276 inline bool CrawlElapsedTimeHasBeenSet() const { return m_crawlElapsedTimeHasBeenSet; }
277 inline void SetCrawlElapsedTime(long long value) {
278 m_crawlElapsedTimeHasBeenSet = true;
279 m_crawlElapsedTime = value;
280 }
281 inline Crawler& WithCrawlElapsedTime(long long value) {
282 SetCrawlElapsedTime(value);
283 return *this;
284 }
286
288
291 inline const Aws::Utils::DateTime& GetCreationTime() const { return m_creationTime; }
292 inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; }
293 template <typename CreationTimeT = Aws::Utils::DateTime>
294 void SetCreationTime(CreationTimeT&& value) {
295 m_creationTimeHasBeenSet = true;
296 m_creationTime = std::forward<CreationTimeT>(value);
297 }
298 template <typename CreationTimeT = Aws::Utils::DateTime>
299 Crawler& WithCreationTime(CreationTimeT&& value) {
300 SetCreationTime(std::forward<CreationTimeT>(value));
301 return *this;
302 }
304
306
309 inline const Aws::Utils::DateTime& GetLastUpdated() const { return m_lastUpdated; }
310 inline bool LastUpdatedHasBeenSet() const { return m_lastUpdatedHasBeenSet; }
311 template <typename LastUpdatedT = Aws::Utils::DateTime>
312 void SetLastUpdated(LastUpdatedT&& value) {
313 m_lastUpdatedHasBeenSet = true;
314 m_lastUpdated = std::forward<LastUpdatedT>(value);
315 }
316 template <typename LastUpdatedT = Aws::Utils::DateTime>
317 Crawler& WithLastUpdated(LastUpdatedT&& value) {
318 SetLastUpdated(std::forward<LastUpdatedT>(value));
319 return *this;
320 }
322
324
328 inline const LastCrawlInfo& GetLastCrawl() const { return m_lastCrawl; }
329 inline bool LastCrawlHasBeenSet() const { return m_lastCrawlHasBeenSet; }
330 template <typename LastCrawlT = LastCrawlInfo>
331 void SetLastCrawl(LastCrawlT&& value) {
332 m_lastCrawlHasBeenSet = true;
333 m_lastCrawl = std::forward<LastCrawlT>(value);
334 }
335 template <typename LastCrawlT = LastCrawlInfo>
336 Crawler& WithLastCrawl(LastCrawlT&& value) {
337 SetLastCrawl(std::forward<LastCrawlT>(value));
338 return *this;
339 }
341
343
346 inline long long GetVersion() const { return m_version; }
347 inline bool VersionHasBeenSet() const { return m_versionHasBeenSet; }
348 inline void SetVersion(long long value) {
349 m_versionHasBeenSet = true;
350 m_version = value;
351 }
352 inline Crawler& WithVersion(long long value) {
353 SetVersion(value);
354 return *this;
355 }
357
359
365 inline const Aws::String& GetConfiguration() const { return m_configuration; }
366 inline bool ConfigurationHasBeenSet() const { return m_configurationHasBeenSet; }
367 template <typename ConfigurationT = Aws::String>
368 void SetConfiguration(ConfigurationT&& value) {
369 m_configurationHasBeenSet = true;
370 m_configuration = std::forward<ConfigurationT>(value);
371 }
372 template <typename ConfigurationT = Aws::String>
373 Crawler& WithConfiguration(ConfigurationT&& value) {
374 SetConfiguration(std::forward<ConfigurationT>(value));
375 return *this;
376 }
378
380
384 inline const Aws::String& GetCrawlerSecurityConfiguration() const { return m_crawlerSecurityConfiguration; }
385 inline bool CrawlerSecurityConfigurationHasBeenSet() const { return m_crawlerSecurityConfigurationHasBeenSet; }
386 template <typename CrawlerSecurityConfigurationT = Aws::String>
387 void SetCrawlerSecurityConfiguration(CrawlerSecurityConfigurationT&& value) {
388 m_crawlerSecurityConfigurationHasBeenSet = true;
389 m_crawlerSecurityConfiguration = std::forward<CrawlerSecurityConfigurationT>(value);
390 }
391 template <typename CrawlerSecurityConfigurationT = Aws::String>
392 Crawler& WithCrawlerSecurityConfiguration(CrawlerSecurityConfigurationT&& value) {
393 SetCrawlerSecurityConfiguration(std::forward<CrawlerSecurityConfigurationT>(value));
394 return *this;
395 }
397
399
403 inline const LakeFormationConfiguration& GetLakeFormationConfiguration() const { return m_lakeFormationConfiguration; }
404 inline bool LakeFormationConfigurationHasBeenSet() const { return m_lakeFormationConfigurationHasBeenSet; }
405 template <typename LakeFormationConfigurationT = LakeFormationConfiguration>
406 void SetLakeFormationConfiguration(LakeFormationConfigurationT&& value) {
407 m_lakeFormationConfigurationHasBeenSet = true;
408 m_lakeFormationConfiguration = std::forward<LakeFormationConfigurationT>(value);
409 }
410 template <typename LakeFormationConfigurationT = LakeFormationConfiguration>
411 Crawler& WithLakeFormationConfiguration(LakeFormationConfigurationT&& value) {
412 SetLakeFormationConfiguration(std::forward<LakeFormationConfigurationT>(value));
413 return *this;
414 }
416 private:
417 Aws::String m_name;
418
419 Aws::String m_role;
420
421 CrawlerTargets m_targets;
422
423 Aws::String m_databaseName;
424
425 Aws::String m_description;
426
427 Aws::Vector<Aws::String> m_classifiers;
428
429 RecrawlPolicy m_recrawlPolicy;
430
431 SchemaChangePolicy m_schemaChangePolicy;
432
433 LineageConfiguration m_lineageConfiguration;
434
436
437 Aws::String m_tablePrefix;
438
439 Schedule m_schedule;
440
441 long long m_crawlElapsedTime{0};
442
443 Aws::Utils::DateTime m_creationTime{};
444
445 Aws::Utils::DateTime m_lastUpdated{};
446
447 LastCrawlInfo m_lastCrawl;
448
449 long long m_version{0};
450
451 Aws::String m_configuration;
452
453 Aws::String m_crawlerSecurityConfiguration;
454
455 LakeFormationConfiguration m_lakeFormationConfiguration;
456 bool m_nameHasBeenSet = false;
457 bool m_roleHasBeenSet = false;
458 bool m_targetsHasBeenSet = false;
459 bool m_databaseNameHasBeenSet = false;
460 bool m_descriptionHasBeenSet = false;
461 bool m_classifiersHasBeenSet = false;
462 bool m_recrawlPolicyHasBeenSet = false;
463 bool m_schemaChangePolicyHasBeenSet = false;
464 bool m_lineageConfigurationHasBeenSet = false;
465 bool m_stateHasBeenSet = false;
466 bool m_tablePrefixHasBeenSet = false;
467 bool m_scheduleHasBeenSet = false;
468 bool m_crawlElapsedTimeHasBeenSet = false;
469 bool m_creationTimeHasBeenSet = false;
470 bool m_lastUpdatedHasBeenSet = false;
471 bool m_lastCrawlHasBeenSet = false;
472 bool m_versionHasBeenSet = false;
473 bool m_configurationHasBeenSet = false;
474 bool m_crawlerSecurityConfigurationHasBeenSet = false;
475 bool m_lakeFormationConfigurationHasBeenSet = false;
476};
477
478} // namespace Model
479} // namespace Glue
480} // namespace Aws
Crawler & WithLineageConfiguration(LineageConfigurationT &&value)
Definition Crawler.h:212
Crawler & WithRole(RoleT &&value)
Definition Crawler.h:77
void SetLastCrawl(LastCrawlT &&value)
Definition Crawler.h:331
void SetSchemaChangePolicy(SchemaChangePolicyT &&value)
Definition Crawler.h:188
Crawler & WithSchedule(ScheduleT &&value)
Definition Crawler.h:264
void SetCrawlerSecurityConfiguration(CrawlerSecurityConfigurationT &&value)
Definition Crawler.h:387
const Aws::Utils::DateTime & GetLastUpdated() const
Definition Crawler.h:309
const CrawlerTargets & GetTargets() const
Definition Crawler.h:87
const Aws::String & GetName() const
Definition Crawler.h:50
Crawler & WithSchemaChangePolicy(SchemaChangePolicyT &&value)
Definition Crawler.h:193
Crawler & WithLastUpdated(LastUpdatedT &&value)
Definition Crawler.h:317
bool VersionHasBeenSet() const
Definition Crawler.h:347
bool ClassifiersHasBeenSet() const
Definition Crawler.h:143
Crawler & WithVersion(long long value)
Definition Crawler.h:352
Crawler & WithState(CrawlerState value)
Definition Crawler.h:228
Crawler & WithClassifiers(ClassifiersT &&value)
Definition Crawler.h:150
void SetName(NameT &&value)
Definition Crawler.h:53
bool CreationTimeHasBeenSet() const
Definition Crawler.h:292
const Aws::String & GetDescription() const
Definition Crawler.h:123
void SetRecrawlPolicy(RecrawlPolicyT &&value)
Definition Crawler.h:170
bool NameHasBeenSet() const
Definition Crawler.h:51
bool ConfigurationHasBeenSet() const
Definition Crawler.h:366
void SetLastUpdated(LastUpdatedT &&value)
Definition Crawler.h:312
bool RoleHasBeenSet() const
Definition Crawler.h:70
bool TargetsHasBeenSet() const
Definition Crawler.h:88
bool DescriptionHasBeenSet() const
Definition Crawler.h:124
Crawler & WithRecrawlPolicy(RecrawlPolicyT &&value)
Definition Crawler.h:175
void SetTablePrefix(TablePrefixT &&value)
Definition Crawler.h:241
AWS_GLUE_API Crawler & operator=(Aws::Utils::Json::JsonView jsonValue)
const SchemaChangePolicy & GetSchemaChangePolicy() const
Definition Crawler.h:185
CrawlerState GetState() const
Definition Crawler.h:222
const Aws::Utils::DateTime & GetCreationTime() const
Definition Crawler.h:291
const Aws::String & GetConfiguration() const
Definition Crawler.h:365
const Aws::Vector< Aws::String > & GetClassifiers() const
Definition Crawler.h:142
Crawler & WithDescription(DescriptionT &&value)
Definition Crawler.h:131
bool ScheduleHasBeenSet() const
Definition Crawler.h:257
AWS_GLUE_API Aws::Utils::Json::JsonValue Jsonize() const
const Aws::String & GetDatabaseName() const
Definition Crawler.h:105
void SetDatabaseName(DatabaseNameT &&value)
Definition Crawler.h:108
Crawler & AddClassifiers(ClassifiersT &&value)
Definition Crawler.h:155
Crawler & WithTargets(TargetsT &&value)
Definition Crawler.h:95
void SetTargets(TargetsT &&value)
Definition Crawler.h:90
Crawler & WithCrawlerSecurityConfiguration(CrawlerSecurityConfigurationT &&value)
Definition Crawler.h:392
void SetCreationTime(CreationTimeT &&value)
Definition Crawler.h:294
bool SchemaChangePolicyHasBeenSet() const
Definition Crawler.h:186
const LastCrawlInfo & GetLastCrawl() const
Definition Crawler.h:328
bool TablePrefixHasBeenSet() const
Definition Crawler.h:239
Crawler & WithLakeFormationConfiguration(LakeFormationConfigurationT &&value)
Definition Crawler.h:411
void SetLakeFormationConfiguration(LakeFormationConfigurationT &&value)
Definition Crawler.h:406
Crawler & WithCrawlElapsedTime(long long value)
Definition Crawler.h:281
const Aws::String & GetRole() const
Definition Crawler.h:69
long long GetCrawlElapsedTime() const
Definition Crawler.h:275
void SetVersion(long long value)
Definition Crawler.h:348
bool CrawlElapsedTimeHasBeenSet() const
Definition Crawler.h:276
AWS_GLUE_API Crawler()=default
bool LastCrawlHasBeenSet() const
Definition Crawler.h:329
void SetState(CrawlerState value)
Definition Crawler.h:224
Crawler & WithCreationTime(CreationTimeT &&value)
Definition Crawler.h:299
bool StateHasBeenSet() const
Definition Crawler.h:223
Crawler & WithName(NameT &&value)
Definition Crawler.h:58
void SetCrawlElapsedTime(long long value)
Definition Crawler.h:277
Crawler & WithLastCrawl(LastCrawlT &&value)
Definition Crawler.h:336
void SetLineageConfiguration(LineageConfigurationT &&value)
Definition Crawler.h:207
const Aws::String & GetTablePrefix() const
Definition Crawler.h:238
void SetConfiguration(ConfigurationT &&value)
Definition Crawler.h:368
void SetSchedule(ScheduleT &&value)
Definition Crawler.h:259
Crawler & WithDatabaseName(DatabaseNameT &&value)
Definition Crawler.h:113
bool LakeFormationConfigurationHasBeenSet() const
Definition Crawler.h:404
bool CrawlerSecurityConfigurationHasBeenSet() const
Definition Crawler.h:385
bool LineageConfigurationHasBeenSet() const
Definition Crawler.h:205
Crawler & WithTablePrefix(TablePrefixT &&value)
Definition Crawler.h:246
bool LastUpdatedHasBeenSet() const
Definition Crawler.h:310
void SetRole(RoleT &&value)
Definition Crawler.h:72
void SetDescription(DescriptionT &&value)
Definition Crawler.h:126
bool RecrawlPolicyHasBeenSet() const
Definition Crawler.h:168
const RecrawlPolicy & GetRecrawlPolicy() const
Definition Crawler.h:167
Crawler & WithConfiguration(ConfigurationT &&value)
Definition Crawler.h:373
AWS_GLUE_API Crawler(Aws::Utils::Json::JsonView jsonValue)
const Aws::String & GetCrawlerSecurityConfiguration() const
Definition Crawler.h:384
const LineageConfiguration & GetLineageConfiguration() const
Definition Crawler.h:204
long long GetVersion() const
Definition Crawler.h:346
const LakeFormationConfiguration & GetLakeFormationConfiguration() const
Definition Crawler.h:403
bool DatabaseNameHasBeenSet() const
Definition Crawler.h:106
const Schedule & GetSchedule() const
Definition Crawler.h:256
void SetClassifiers(ClassifiersT &&value)
Definition Crawler.h:145
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector
Aws::Utils::Json::JsonValue JsonValue