Fawkes API Fawkes Development Version
PluginOpRequest.h
1
2/****************************************************************************
3 * Plugin -- Schema PluginOpRequest
4 * (auto-generated, do not modify directly)
5 *
6 * Fawkes Plugin REST API.
7 * List, load, and unload plugins.
8 *
9 * API Contact: Tim Niemueller <niemueller@kbsg.rwth-aachen.de>
10 * API Version: v1beta1
11 * API License: Apache 2.0
12 ****************************************************************************/
13
14#pragma once
15
16#define RAPIDJSON_HAS_STDSTRING 1
17#include <rapidjson/fwd.h>
18
19#include <cstdint>
20#include <memory>
21#include <optional>
22#include <string>
23#include <vector>
24
25/** PluginOpRequest representation for JSON transfer. */
27
28{
29public:
30 /** Constructor. */
32 /** Constructor from JSON.
33 * @param json JSON string to initialize from
34 */
35 PluginOpRequest(const std::string &json);
36 /** Constructor from JSON.
37 * @param v RapidJSON value object to initialize from.
38 */
39 PluginOpRequest(const rapidjson::Value &v);
40
41 /** Destructor. */
42 virtual ~PluginOpRequest();
43
44 /** Get version of implemented API.
45 * @return string representation of version
46 */
47 static std::string
49 {
50 return "v1beta1";
51 }
52
53 /** Render object to JSON.
54 * @param pretty true to enable pretty printing (readable spacing)
55 * @return JSON string
56 */
57 virtual std::string to_json(bool pretty = false) const;
58 /** Render object to JSON.
59 * @param d RapidJSON document to retrieve allocator from
60 * @param v RapidJSON value to add data to
61 */
62 virtual void to_json_value(rapidjson::Document &d, rapidjson::Value &v) const;
63 /** Retrieve data from JSON string.
64 * @param json JSON representation suitable for this object.
65 * Will allow partial assignment and not validate automaticaly.
66 * @see validate()
67 */
68 virtual void from_json(const std::string &json);
69 /** Retrieve data from JSON string.
70 * @param v RapidJSON value suitable for this object.
71 * Will allow partial assignment and not validate automaticaly.
72 * @see validate()
73 */
74 virtual void from_json_value(const rapidjson::Value &v);
75
76 /** Validate if all required fields have been set.
77 * @param subcall true if this is called from another class, e.g.,
78 * a sub-class or array holder. Will modify the kind of exception thrown.
79 * @exception std::vector<std::string> thrown if required information is
80 * missing and @p subcall is set to true. Contains a list of missing fields.
81 * @exception std::runtime_error informative message describing the missing
82 * fields
83 */
84 virtual void validate(bool subcall = false) const;
85
86 // Schema: PluginOpRequest
87public:
88 /** Get kind value.
89 * @return kind value
90 */
91 std::optional<std::string>
92 kind() const
93 {
94 return kind_;
95 }
96
97 /** Set kind value.
98 * @param kind new value
99 */
100 void
101 set_kind(const std::string &kind)
102 {
103 kind_ = kind;
104 }
105 /** Get apiVersion value.
106 * @return apiVersion value
107 */
108 std::optional<std::string>
110 {
111 return apiVersion_;
112 }
113
114 /** Set apiVersion value.
115 * @param apiVersion new value
116 */
117 void
118 set_apiVersion(const std::string &apiVersion)
119 {
120 apiVersion_ = apiVersion;
121 }
122 /** Get desired_state value.
123 * @return desired_state value
124 */
125 std::optional<std::string>
127 {
128 return desired_state_;
129 }
130
131 /** Set desired_state value.
132 * @param desired_state new value
133 */
134 void
136 {
137 desired_state_ = desired_state;
138 }
139
140private:
141 std::optional<std::string> kind_;
142 std::optional<std::string> apiVersion_;
143 std::optional<std::string> desired_state_;
144};
PluginOpRequest representation for JSON transfer.
virtual void from_json_value(const rapidjson::Value &v)
Retrieve data from JSON string.
static std::string api_version()
Get version of implemented API.
void set_apiVersion(const std::string &apiVersion)
Set apiVersion value.
virtual ~PluginOpRequest()
Destructor.
std::optional< std::string > kind() const
Get kind value.
virtual void to_json_value(rapidjson::Document &d, rapidjson::Value &v) const
Render object to JSON.
void set_desired_state(const std::string &desired_state)
Set desired_state value.
virtual std::string to_json(bool pretty=false) const
Render object to JSON.
virtual void from_json(const std::string &json)
Retrieve data from JSON string.
std::optional< std::string > desired_state() const
Get desired_state value.
virtual void validate(bool subcall=false) const
Validate if all required fields have been set.
void set_kind(const std::string &kind)
Set kind value.
PluginOpRequest()
Constructor.
std::optional< std::string > apiVersion() const
Get apiVersion value.