/
model_meta.go
413 lines (344 loc) · 13.5 KB
/
model_meta.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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
/*
Metal API
# Introduction Equinix Metal provides a RESTful HTTP API which can be reached at <https://api.equinix.com/metal/v1>. This document describes the API and how to use it. The API allows you to programmatically interact with all of your Equinix Metal resources, including devices, networks, addresses, organizations, projects, and your user account. Every feature of the Equinix Metal web interface is accessible through the API. The API docs are generated from the Equinix Metal OpenAPI specification and are officially hosted at <https://metal.equinix.com/developers/api>. # Common Parameters The Equinix Metal API uses a few methods to minimize network traffic and improve throughput. These parameters are not used in all API calls, but are used often enough to warrant their own section. Look for these parameters in the documentation for the API calls that support them. ## Pagination Pagination is used to limit the number of results returned in a single request. The API will return a maximum of 100 results per page. To retrieve additional results, you can use the `page` and `per_page` query parameters. The `page` parameter is used to specify the page number. The first page is `1`. The `per_page` parameter is used to specify the number of results per page. The maximum number of results differs by resource type. ## Sorting Where offered, the API allows you to sort results by a specific field. To sort results use the `sort_by` query parameter with the root level field name as the value. The `sort_direction` parameter is used to specify the sort direction, either either `asc` (ascending) or `desc` (descending). ## Filtering Filtering is used to limit the results returned in a single request. The API supports filtering by certain fields in the response. To filter results, you can use the field as a query parameter. For example, to filter the IP list to only return public IPv4 addresses, you can filter by the `type` field, as in the following request: ```sh curl -H 'X-Auth-Token: my_authentication_token' \\ https://api.equinix.com/metal/v1/projects/id/ips?type=public_ipv4 ``` Only IP addresses with the `type` field set to `public_ipv4` will be returned. ## Searching Searching is used to find matching resources using multiple field comparissons. The API supports searching in resources that define this behavior. Currently the search parameter is only available on devices, ssh_keys, api_keys and memberships endpoints. To search resources you can use the `search` query parameter. ## Include and Exclude For resources that contain references to other resources, sucha as a Device that refers to the Project it resides in, the Equinix Metal API will returns `href` values (API links) to the associated resource. ```json { ... \"project\": { \"href\": \"/metal/v1/projects/f3f131c8-f302-49ef-8c44-9405022dc6dd\" } } ``` If you're going need the project details, you can avoid a second API request. Specify the contained `href` resources and collections that you'd like to have included in the response using the `include` query parameter. For example: ```sh curl -H 'X-Auth-Token: my_authentication_token' \\ https://api.equinix.com/metal/v1/user?include=projects ``` The `include` parameter is generally accepted in `GET`, `POST`, `PUT`, and `PATCH` requests where `href` resources are presented. To have multiple resources include, use a comma-separated list (e.g. `?include=emails,projects,memberships`). ```sh curl -H 'X-Auth-Token: my_authentication_token' \\ https://api.equinix.com/metal/v1/user?include=emails,projects,memberships ``` You may also include nested associations up to three levels deep using dot notation (`?include=memberships.projects`): ```sh curl -H 'X-Auth-Token: my_authentication_token' \\ https://api.equinix.com/metal/v1/user?include=memberships.projects ``` To exclude resources, and optimize response delivery, use the `exclude` query parameter. The `exclude` parameter is generally accepted in `GET`, `POST`, `PUT`, and `PATCH` requests for fields with nested object responses. When excluded, these fields will be replaced with an object that contains only an `href` field.
API version: 1.0.0
Contact: support@equinixmetal.com
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package v1
import (
"encoding/json"
)
// checks if the Meta type satisfies the MappedNullable interface at compile time
var _ MappedNullable = &Meta{}
// Meta struct for Meta
type Meta struct {
First *Href `json:"first,omitempty"`
Last *Href `json:"last,omitempty"`
Next *Href `json:"next,omitempty"`
Previous *Href `json:"previous,omitempty"`
Self *Href `json:"self,omitempty"`
Total *int32 `json:"total,omitempty"`
CurrentPage *int32 `json:"current_page,omitempty"`
LastPage *int32 `json:"last_page,omitempty"`
AdditionalProperties map[string]interface{}
}
type _Meta Meta
// NewMeta instantiates a new Meta 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 NewMeta() *Meta {
this := Meta{}
return &this
}
// NewMetaWithDefaults instantiates a new Meta 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 NewMetaWithDefaults() *Meta {
this := Meta{}
return &this
}
// GetFirst returns the First field value if set, zero value otherwise.
func (o *Meta) GetFirst() Href {
if o == nil || IsNil(o.First) {
var ret Href
return ret
}
return *o.First
}
// GetFirstOk returns a tuple with the First field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *Meta) GetFirstOk() (*Href, bool) {
if o == nil || IsNil(o.First) {
return nil, false
}
return o.First, true
}
// HasFirst returns a boolean if a field has been set.
func (o *Meta) HasFirst() bool {
if o != nil && !IsNil(o.First) {
return true
}
return false
}
// SetFirst gets a reference to the given Href and assigns it to the First field.
func (o *Meta) SetFirst(v Href) {
o.First = &v
}
// GetLast returns the Last field value if set, zero value otherwise.
func (o *Meta) GetLast() Href {
if o == nil || IsNil(o.Last) {
var ret Href
return ret
}
return *o.Last
}
// GetLastOk returns a tuple with the Last field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *Meta) GetLastOk() (*Href, bool) {
if o == nil || IsNil(o.Last) {
return nil, false
}
return o.Last, true
}
// HasLast returns a boolean if a field has been set.
func (o *Meta) HasLast() bool {
if o != nil && !IsNil(o.Last) {
return true
}
return false
}
// SetLast gets a reference to the given Href and assigns it to the Last field.
func (o *Meta) SetLast(v Href) {
o.Last = &v
}
// GetNext returns the Next field value if set, zero value otherwise.
func (o *Meta) GetNext() Href {
if o == nil || IsNil(o.Next) {
var ret Href
return ret
}
return *o.Next
}
// GetNextOk returns a tuple with the Next field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *Meta) GetNextOk() (*Href, bool) {
if o == nil || IsNil(o.Next) {
return nil, false
}
return o.Next, true
}
// HasNext returns a boolean if a field has been set.
func (o *Meta) HasNext() bool {
if o != nil && !IsNil(o.Next) {
return true
}
return false
}
// SetNext gets a reference to the given Href and assigns it to the Next field.
func (o *Meta) SetNext(v Href) {
o.Next = &v
}
// GetPrevious returns the Previous field value if set, zero value otherwise.
func (o *Meta) GetPrevious() Href {
if o == nil || IsNil(o.Previous) {
var ret Href
return ret
}
return *o.Previous
}
// GetPreviousOk returns a tuple with the Previous field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *Meta) GetPreviousOk() (*Href, bool) {
if o == nil || IsNil(o.Previous) {
return nil, false
}
return o.Previous, true
}
// HasPrevious returns a boolean if a field has been set.
func (o *Meta) HasPrevious() bool {
if o != nil && !IsNil(o.Previous) {
return true
}
return false
}
// SetPrevious gets a reference to the given Href and assigns it to the Previous field.
func (o *Meta) SetPrevious(v Href) {
o.Previous = &v
}
// GetSelf returns the Self field value if set, zero value otherwise.
func (o *Meta) GetSelf() Href {
if o == nil || IsNil(o.Self) {
var ret Href
return ret
}
return *o.Self
}
// GetSelfOk returns a tuple with the Self field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *Meta) GetSelfOk() (*Href, bool) {
if o == nil || IsNil(o.Self) {
return nil, false
}
return o.Self, true
}
// HasSelf returns a boolean if a field has been set.
func (o *Meta) HasSelf() bool {
if o != nil && !IsNil(o.Self) {
return true
}
return false
}
// SetSelf gets a reference to the given Href and assigns it to the Self field.
func (o *Meta) SetSelf(v Href) {
o.Self = &v
}
// GetTotal returns the Total field value if set, zero value otherwise.
func (o *Meta) GetTotal() int32 {
if o == nil || IsNil(o.Total) {
var ret int32
return ret
}
return *o.Total
}
// GetTotalOk returns a tuple with the Total field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *Meta) GetTotalOk() (*int32, bool) {
if o == nil || IsNil(o.Total) {
return nil, false
}
return o.Total, true
}
// HasTotal returns a boolean if a field has been set.
func (o *Meta) HasTotal() bool {
if o != nil && !IsNil(o.Total) {
return true
}
return false
}
// SetTotal gets a reference to the given int32 and assigns it to the Total field.
func (o *Meta) SetTotal(v int32) {
o.Total = &v
}
// GetCurrentPage returns the CurrentPage field value if set, zero value otherwise.
func (o *Meta) GetCurrentPage() int32 {
if o == nil || IsNil(o.CurrentPage) {
var ret int32
return ret
}
return *o.CurrentPage
}
// GetCurrentPageOk returns a tuple with the CurrentPage field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *Meta) GetCurrentPageOk() (*int32, bool) {
if o == nil || IsNil(o.CurrentPage) {
return nil, false
}
return o.CurrentPage, true
}
// HasCurrentPage returns a boolean if a field has been set.
func (o *Meta) HasCurrentPage() bool {
if o != nil && !IsNil(o.CurrentPage) {
return true
}
return false
}
// SetCurrentPage gets a reference to the given int32 and assigns it to the CurrentPage field.
func (o *Meta) SetCurrentPage(v int32) {
o.CurrentPage = &v
}
// GetLastPage returns the LastPage field value if set, zero value otherwise.
func (o *Meta) GetLastPage() int32 {
if o == nil || IsNil(o.LastPage) {
var ret int32
return ret
}
return *o.LastPage
}
// GetLastPageOk returns a tuple with the LastPage field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *Meta) GetLastPageOk() (*int32, bool) {
if o == nil || IsNil(o.LastPage) {
return nil, false
}
return o.LastPage, true
}
// HasLastPage returns a boolean if a field has been set.
func (o *Meta) HasLastPage() bool {
if o != nil && !IsNil(o.LastPage) {
return true
}
return false
}
// SetLastPage gets a reference to the given int32 and assigns it to the LastPage field.
func (o *Meta) SetLastPage(v int32) {
o.LastPage = &v
}
func (o Meta) MarshalJSON() ([]byte, error) {
toSerialize, err := o.ToMap()
if err != nil {
return []byte{}, err
}
return json.Marshal(toSerialize)
}
func (o Meta) ToMap() (map[string]interface{}, error) {
toSerialize := map[string]interface{}{}
if !IsNil(o.First) {
toSerialize["first"] = o.First
}
if !IsNil(o.Last) {
toSerialize["last"] = o.Last
}
if !IsNil(o.Next) {
toSerialize["next"] = o.Next
}
if !IsNil(o.Previous) {
toSerialize["previous"] = o.Previous
}
if !IsNil(o.Self) {
toSerialize["self"] = o.Self
}
if !IsNil(o.Total) {
toSerialize["total"] = o.Total
}
if !IsNil(o.CurrentPage) {
toSerialize["current_page"] = o.CurrentPage
}
if !IsNil(o.LastPage) {
toSerialize["last_page"] = o.LastPage
}
for key, value := range o.AdditionalProperties {
toSerialize[key] = value
}
return toSerialize, nil
}
func (o *Meta) UnmarshalJSON(bytes []byte) (err error) {
varMeta := _Meta{}
err = json.Unmarshal(bytes, &varMeta)
if err != nil {
return err
}
*o = Meta(varMeta)
additionalProperties := make(map[string]interface{})
if err = json.Unmarshal(bytes, &additionalProperties); err == nil {
delete(additionalProperties, "first")
delete(additionalProperties, "last")
delete(additionalProperties, "next")
delete(additionalProperties, "previous")
delete(additionalProperties, "self")
delete(additionalProperties, "total")
delete(additionalProperties, "current_page")
delete(additionalProperties, "last_page")
o.AdditionalProperties = additionalProperties
}
return err
}
type NullableMeta struct {
value *Meta
isSet bool
}
func (v NullableMeta) Get() *Meta {
return v.value
}
func (v *NullableMeta) Set(val *Meta) {
v.value = val
v.isSet = true
}
func (v NullableMeta) IsSet() bool {
return v.isSet
}
func (v *NullableMeta) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableMeta(val *Meta) *NullableMeta {
return &NullableMeta{value: val, isSet: true}
}
func (v NullableMeta) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableMeta) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}