-
Notifications
You must be signed in to change notification settings - Fork 1
/
model_on_boarded_devices.go
227 lines (190 loc) · 9.41 KB
/
model_on_boarded_devices.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
/*
Appgate SDP Controller REST API
# About This specification documents the REST API calls for the Appgate SDP Controller. Please refer to the REST API chapter in the manual or contact Appgate support with any questions about this functionality. # Getting Started Requirements for API scripting: - Access to the Admin/API TLS Connection (default port 8443) of a Controller appliance. (https://sdphelp.appgate.com/adminguide/appliance-function-configure.html?anchor=admin-api) - An API user with relevant permissions. (https://sdphelp.appgate.com/adminguide/administrative-roles-configure.html) - In order to use the simple login API, Admin MFA must be disabled or the API user must be excluded. (https://sdphelp.appgate.com/adminguide/mfa-for-admins.html) # Base path HTTPS requests must be sent to the Admin Interface hostname and port, with **_/admin** path. For example: **https://appgate.company.com:8443/admin** All requests must have the **Accept** header as: **application/vnd.appgate.peer-v20+json** An exception is made for the **_/admin/version** endpoint which instead expects an **application/json** Accept header. # API Conventions API conventions are important to understand and follow strictly. - While updating objects (via PUT), entire object must be sent with all fields. - For example, in order to add a remedy method to the condition below: ``` { \"id\": \"12699e27-b584-464a-81ee-5b4784b6d425\", \"name\": \"Test\", \"notes\": \"Making a point\", \"tags\": [\"test\", \"tag\"], \"expression\": \"return true;\", \"remedyMethods\": [] } ``` - send the entire object with updated and non-updated fields: ``` { \"id\": \"12699e27-b584-464a-81ee-5b4784b6d425\", \"name\": \"Test\", \"notes\": \"Making a point\", \"tags\": [\"test\", \"tag\"], \"expression\": \"return true;\", \"remedyMethods\": [{\"type\": \"DisplayMessage\", \"message\": \"test message\"}] } ``` - In case Controller returns an error (non-2xx HTTP status code), response body is JSON. The \"message\" field contains information about the error. HTTP 422 \"Unprocessable Entity\" has extra `errors` field to list all the issues with specific fields. - Empty string (\"\") is considered a different value than \"null\" or field being omitted from JSON. Omitting the field is recommended if no value is intended. Empty string (\"\") will be almost always rejected as invalid value. - There are common pattern between many objects: - **Configuration Objects**: There are many objects with common fields, namely \"id\", \"name\", \"notes\", \"created\" and \"updated\". These entities are listed, queried, created, updated and deleted in a similar fashion. - **Distinguished Name**: Users and Devices are identified with what is called Distinguished Names, as used in LDAP. The distinguished format that identifies a device and a user combination is \"CN=\\<Device ID\\>,CN=\\<username\\>,OU=\\<Identity Provider Name\\>\". Some objects have the \"userDistinguishedName\" field, which does not include the CN for Device ID. This identifies a user on every device.
API version: API version 20.0
Contact: appgatesdp.support@appgate.com
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package openapi
import (
"encoding/json"
"time"
)
// OnBoardedDevices struct for OnBoardedDevices
type OnBoardedDevices struct {
// User-friendly name for the stats.
Name *string `json:"name,omitempty"`
// The time the stats was generated.
CreationDate *time.Time `json:"creationDate,omitempty"`
// Recommended refresh interval in minutes.
RefreshInterval *float32 `json:"refreshInterval,omitempty"`
// A dictionary of Device On-Boardings Per hour. The key is the hour, the value is the amount of on-boards. For example 8:24 means, between 08:00 - 09:00, 24 on-boards have occurred. Times are UTC based and if the hour number is after the current time, it represents the day before.
Data *map[string]float32 `json:"data,omitempty"`
}
// NewOnBoardedDevices instantiates a new OnBoardedDevices object
// This constructor will assign default values to properties that have it defined,
// and makes sure properties required by API are set, but the set of arguments
// will change when the set of required properties is changed
func NewOnBoardedDevices() *OnBoardedDevices {
this := OnBoardedDevices{}
return &this
}
// NewOnBoardedDevicesWithDefaults instantiates a new OnBoardedDevices object
// This constructor will only assign default values to properties that have it defined,
// but it doesn't guarantee that properties required by API are set
func NewOnBoardedDevicesWithDefaults() *OnBoardedDevices {
this := OnBoardedDevices{}
return &this
}
// GetName returns the Name field value if set, zero value otherwise.
func (o *OnBoardedDevices) GetName() string {
if o == nil || o.Name == nil {
var ret string
return ret
}
return *o.Name
}
// GetNameOk returns a tuple with the Name field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *OnBoardedDevices) GetNameOk() (*string, bool) {
if o == nil || o.Name == nil {
return nil, false
}
return o.Name, true
}
// HasName returns a boolean if a field has been set.
func (o *OnBoardedDevices) HasName() bool {
if o != nil && o.Name != nil {
return true
}
return false
}
// SetName gets a reference to the given string and assigns it to the Name field.
func (o *OnBoardedDevices) SetName(v string) {
o.Name = &v
}
// GetCreationDate returns the CreationDate field value if set, zero value otherwise.
func (o *OnBoardedDevices) GetCreationDate() time.Time {
if o == nil || o.CreationDate == nil {
var ret time.Time
return ret
}
return *o.CreationDate
}
// GetCreationDateOk returns a tuple with the CreationDate field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *OnBoardedDevices) GetCreationDateOk() (*time.Time, bool) {
if o == nil || o.CreationDate == nil {
return nil, false
}
return o.CreationDate, true
}
// HasCreationDate returns a boolean if a field has been set.
func (o *OnBoardedDevices) HasCreationDate() bool {
if o != nil && o.CreationDate != nil {
return true
}
return false
}
// SetCreationDate gets a reference to the given time.Time and assigns it to the CreationDate field.
func (o *OnBoardedDevices) SetCreationDate(v time.Time) {
o.CreationDate = &v
}
// GetRefreshInterval returns the RefreshInterval field value if set, zero value otherwise.
func (o *OnBoardedDevices) GetRefreshInterval() float32 {
if o == nil || o.RefreshInterval == nil {
var ret float32
return ret
}
return *o.RefreshInterval
}
// GetRefreshIntervalOk returns a tuple with the RefreshInterval field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *OnBoardedDevices) GetRefreshIntervalOk() (*float32, bool) {
if o == nil || o.RefreshInterval == nil {
return nil, false
}
return o.RefreshInterval, true
}
// HasRefreshInterval returns a boolean if a field has been set.
func (o *OnBoardedDevices) HasRefreshInterval() bool {
if o != nil && o.RefreshInterval != nil {
return true
}
return false
}
// SetRefreshInterval gets a reference to the given float32 and assigns it to the RefreshInterval field.
func (o *OnBoardedDevices) SetRefreshInterval(v float32) {
o.RefreshInterval = &v
}
// GetData returns the Data field value if set, zero value otherwise.
func (o *OnBoardedDevices) GetData() map[string]float32 {
if o == nil || o.Data == nil {
var ret map[string]float32
return ret
}
return *o.Data
}
// GetDataOk returns a tuple with the Data field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *OnBoardedDevices) GetDataOk() (*map[string]float32, bool) {
if o == nil || o.Data == nil {
return nil, false
}
return o.Data, true
}
// HasData returns a boolean if a field has been set.
func (o *OnBoardedDevices) HasData() bool {
if o != nil && o.Data != nil {
return true
}
return false
}
// SetData gets a reference to the given map[string]float32 and assigns it to the Data field.
func (o *OnBoardedDevices) SetData(v map[string]float32) {
o.Data = &v
}
func (o OnBoardedDevices) MarshalJSON() ([]byte, error) {
toSerialize := map[string]interface{}{}
if o.Name != nil {
toSerialize["name"] = o.Name
}
if o.CreationDate != nil {
toSerialize["creationDate"] = o.CreationDate
}
if o.RefreshInterval != nil {
toSerialize["refreshInterval"] = o.RefreshInterval
}
if o.Data != nil {
toSerialize["data"] = o.Data
}
return json.Marshal(toSerialize)
}
type NullableOnBoardedDevices struct {
value *OnBoardedDevices
isSet bool
}
func (v NullableOnBoardedDevices) Get() *OnBoardedDevices {
return v.value
}
func (v *NullableOnBoardedDevices) Set(val *OnBoardedDevices) {
v.value = val
v.isSet = true
}
func (v NullableOnBoardedDevices) IsSet() bool {
return v.isSet
}
func (v *NullableOnBoardedDevices) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableOnBoardedDevices(val *OnBoardedDevices) *NullableOnBoardedDevices {
return &NullableOnBoardedDevices{value: val, isSet: true}
}
func (v NullableOnBoardedDevices) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableOnBoardedDevices) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}