-
Notifications
You must be signed in to change notification settings - Fork 5
/
model_virtual_network.go
603 lines (509 loc) · 20.1 KB
/
model_virtual_network.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
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
/*
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 metalv1
import (
"encoding/json"
"time"
)
// checks if the VirtualNetwork type satisfies the MappedNullable interface at compile time
var _ MappedNullable = &VirtualNetwork{}
// VirtualNetwork struct for VirtualNetwork
type VirtualNetwork struct {
AssignedTo *Project `json:"assigned_to,omitempty"`
// True if the virtual network is attached to a virtual circuit. False if not.
AssignedToVirtualCircuit *bool `json:"assigned_to_virtual_circuit,omitempty"`
Description *string `json:"description,omitempty"`
Facility *Href `json:"facility,omitempty"`
Href *string `json:"href,omitempty"`
CreatedAt *time.Time `json:"created_at,omitempty"`
Id *string `json:"id,omitempty"`
// A list of instances with ports currently associated to this Virtual Network.
Instances []Device `json:"instances,omitempty"`
// A list of metal gateways currently associated to this Virtual Network.
MetalGateways []MetalGatewayLite `json:"metal_gateways,omitempty"`
Metro *Metro `json:"metro,omitempty"`
// The Metro code of the metro in which this Virtual Network is defined.
MetroCode *string `json:"metro_code,omitempty"`
Vxlan *int32 `json:"vxlan,omitempty"`
Tags []string `json:"tags,omitempty"`
AdditionalProperties map[string]interface{}
}
type _VirtualNetwork VirtualNetwork
// NewVirtualNetwork instantiates a new VirtualNetwork 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 NewVirtualNetwork() *VirtualNetwork {
this := VirtualNetwork{}
return &this
}
// NewVirtualNetworkWithDefaults instantiates a new VirtualNetwork 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 NewVirtualNetworkWithDefaults() *VirtualNetwork {
this := VirtualNetwork{}
return &this
}
// GetAssignedTo returns the AssignedTo field value if set, zero value otherwise.
func (o *VirtualNetwork) GetAssignedTo() Project {
if o == nil || IsNil(o.AssignedTo) {
var ret Project
return ret
}
return *o.AssignedTo
}
// GetAssignedToOk returns a tuple with the AssignedTo field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VirtualNetwork) GetAssignedToOk() (*Project, bool) {
if o == nil || IsNil(o.AssignedTo) {
return nil, false
}
return o.AssignedTo, true
}
// HasAssignedTo returns a boolean if a field has been set.
func (o *VirtualNetwork) HasAssignedTo() bool {
if o != nil && !IsNil(o.AssignedTo) {
return true
}
return false
}
// SetAssignedTo gets a reference to the given Project and assigns it to the AssignedTo field.
func (o *VirtualNetwork) SetAssignedTo(v Project) {
o.AssignedTo = &v
}
// GetAssignedToVirtualCircuit returns the AssignedToVirtualCircuit field value if set, zero value otherwise.
func (o *VirtualNetwork) GetAssignedToVirtualCircuit() bool {
if o == nil || IsNil(o.AssignedToVirtualCircuit) {
var ret bool
return ret
}
return *o.AssignedToVirtualCircuit
}
// GetAssignedToVirtualCircuitOk returns a tuple with the AssignedToVirtualCircuit field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VirtualNetwork) GetAssignedToVirtualCircuitOk() (*bool, bool) {
if o == nil || IsNil(o.AssignedToVirtualCircuit) {
return nil, false
}
return o.AssignedToVirtualCircuit, true
}
// HasAssignedToVirtualCircuit returns a boolean if a field has been set.
func (o *VirtualNetwork) HasAssignedToVirtualCircuit() bool {
if o != nil && !IsNil(o.AssignedToVirtualCircuit) {
return true
}
return false
}
// SetAssignedToVirtualCircuit gets a reference to the given bool and assigns it to the AssignedToVirtualCircuit field.
func (o *VirtualNetwork) SetAssignedToVirtualCircuit(v bool) {
o.AssignedToVirtualCircuit = &v
}
// GetDescription returns the Description field value if set, zero value otherwise.
func (o *VirtualNetwork) GetDescription() string {
if o == nil || IsNil(o.Description) {
var ret string
return ret
}
return *o.Description
}
// GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VirtualNetwork) GetDescriptionOk() (*string, bool) {
if o == nil || IsNil(o.Description) {
return nil, false
}
return o.Description, true
}
// HasDescription returns a boolean if a field has been set.
func (o *VirtualNetwork) HasDescription() bool {
if o != nil && !IsNil(o.Description) {
return true
}
return false
}
// SetDescription gets a reference to the given string and assigns it to the Description field.
func (o *VirtualNetwork) SetDescription(v string) {
o.Description = &v
}
// GetFacility returns the Facility field value if set, zero value otherwise.
func (o *VirtualNetwork) GetFacility() Href {
if o == nil || IsNil(o.Facility) {
var ret Href
return ret
}
return *o.Facility
}
// GetFacilityOk returns a tuple with the Facility field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VirtualNetwork) GetFacilityOk() (*Href, bool) {
if o == nil || IsNil(o.Facility) {
return nil, false
}
return o.Facility, true
}
// HasFacility returns a boolean if a field has been set.
func (o *VirtualNetwork) HasFacility() bool {
if o != nil && !IsNil(o.Facility) {
return true
}
return false
}
// SetFacility gets a reference to the given Href and assigns it to the Facility field.
func (o *VirtualNetwork) SetFacility(v Href) {
o.Facility = &v
}
// GetHref returns the Href field value if set, zero value otherwise.
func (o *VirtualNetwork) GetHref() string {
if o == nil || IsNil(o.Href) {
var ret string
return ret
}
return *o.Href
}
// GetHrefOk returns a tuple with the Href field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VirtualNetwork) GetHrefOk() (*string, bool) {
if o == nil || IsNil(o.Href) {
return nil, false
}
return o.Href, true
}
// HasHref returns a boolean if a field has been set.
func (o *VirtualNetwork) HasHref() bool {
if o != nil && !IsNil(o.Href) {
return true
}
return false
}
// SetHref gets a reference to the given string and assigns it to the Href field.
func (o *VirtualNetwork) SetHref(v string) {
o.Href = &v
}
// GetCreatedAt returns the CreatedAt field value if set, zero value otherwise.
func (o *VirtualNetwork) GetCreatedAt() time.Time {
if o == nil || IsNil(o.CreatedAt) {
var ret time.Time
return ret
}
return *o.CreatedAt
}
// GetCreatedAtOk returns a tuple with the CreatedAt field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VirtualNetwork) GetCreatedAtOk() (*time.Time, bool) {
if o == nil || IsNil(o.CreatedAt) {
return nil, false
}
return o.CreatedAt, true
}
// HasCreatedAt returns a boolean if a field has been set.
func (o *VirtualNetwork) HasCreatedAt() bool {
if o != nil && !IsNil(o.CreatedAt) {
return true
}
return false
}
// SetCreatedAt gets a reference to the given time.Time and assigns it to the CreatedAt field.
func (o *VirtualNetwork) SetCreatedAt(v time.Time) {
o.CreatedAt = &v
}
// GetId returns the Id field value if set, zero value otherwise.
func (o *VirtualNetwork) GetId() string {
if o == nil || IsNil(o.Id) {
var ret string
return ret
}
return *o.Id
}
// GetIdOk returns a tuple with the Id field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VirtualNetwork) GetIdOk() (*string, bool) {
if o == nil || IsNil(o.Id) {
return nil, false
}
return o.Id, true
}
// HasId returns a boolean if a field has been set.
func (o *VirtualNetwork) HasId() bool {
if o != nil && !IsNil(o.Id) {
return true
}
return false
}
// SetId gets a reference to the given string and assigns it to the Id field.
func (o *VirtualNetwork) SetId(v string) {
o.Id = &v
}
// GetInstances returns the Instances field value if set, zero value otherwise.
func (o *VirtualNetwork) GetInstances() []Device {
if o == nil || IsNil(o.Instances) {
var ret []Device
return ret
}
return o.Instances
}
// GetInstancesOk returns a tuple with the Instances field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VirtualNetwork) GetInstancesOk() ([]Device, bool) {
if o == nil || IsNil(o.Instances) {
return nil, false
}
return o.Instances, true
}
// HasInstances returns a boolean if a field has been set.
func (o *VirtualNetwork) HasInstances() bool {
if o != nil && !IsNil(o.Instances) {
return true
}
return false
}
// SetInstances gets a reference to the given []Device and assigns it to the Instances field.
func (o *VirtualNetwork) SetInstances(v []Device) {
o.Instances = v
}
// GetMetalGateways returns the MetalGateways field value if set, zero value otherwise.
func (o *VirtualNetwork) GetMetalGateways() []MetalGatewayLite {
if o == nil || IsNil(o.MetalGateways) {
var ret []MetalGatewayLite
return ret
}
return o.MetalGateways
}
// GetMetalGatewaysOk returns a tuple with the MetalGateways field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VirtualNetwork) GetMetalGatewaysOk() ([]MetalGatewayLite, bool) {
if o == nil || IsNil(o.MetalGateways) {
return nil, false
}
return o.MetalGateways, true
}
// HasMetalGateways returns a boolean if a field has been set.
func (o *VirtualNetwork) HasMetalGateways() bool {
if o != nil && !IsNil(o.MetalGateways) {
return true
}
return false
}
// SetMetalGateways gets a reference to the given []MetalGatewayLite and assigns it to the MetalGateways field.
func (o *VirtualNetwork) SetMetalGateways(v []MetalGatewayLite) {
o.MetalGateways = v
}
// GetMetro returns the Metro field value if set, zero value otherwise.
func (o *VirtualNetwork) GetMetro() Metro {
if o == nil || IsNil(o.Metro) {
var ret Metro
return ret
}
return *o.Metro
}
// GetMetroOk returns a tuple with the Metro field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VirtualNetwork) GetMetroOk() (*Metro, bool) {
if o == nil || IsNil(o.Metro) {
return nil, false
}
return o.Metro, true
}
// HasMetro returns a boolean if a field has been set.
func (o *VirtualNetwork) HasMetro() bool {
if o != nil && !IsNil(o.Metro) {
return true
}
return false
}
// SetMetro gets a reference to the given Metro and assigns it to the Metro field.
func (o *VirtualNetwork) SetMetro(v Metro) {
o.Metro = &v
}
// GetMetroCode returns the MetroCode field value if set, zero value otherwise.
func (o *VirtualNetwork) GetMetroCode() string {
if o == nil || IsNil(o.MetroCode) {
var ret string
return ret
}
return *o.MetroCode
}
// GetMetroCodeOk returns a tuple with the MetroCode field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VirtualNetwork) GetMetroCodeOk() (*string, bool) {
if o == nil || IsNil(o.MetroCode) {
return nil, false
}
return o.MetroCode, true
}
// HasMetroCode returns a boolean if a field has been set.
func (o *VirtualNetwork) HasMetroCode() bool {
if o != nil && !IsNil(o.MetroCode) {
return true
}
return false
}
// SetMetroCode gets a reference to the given string and assigns it to the MetroCode field.
func (o *VirtualNetwork) SetMetroCode(v string) {
o.MetroCode = &v
}
// GetVxlan returns the Vxlan field value if set, zero value otherwise.
func (o *VirtualNetwork) GetVxlan() int32 {
if o == nil || IsNil(o.Vxlan) {
var ret int32
return ret
}
return *o.Vxlan
}
// GetVxlanOk returns a tuple with the Vxlan field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VirtualNetwork) GetVxlanOk() (*int32, bool) {
if o == nil || IsNil(o.Vxlan) {
return nil, false
}
return o.Vxlan, true
}
// HasVxlan returns a boolean if a field has been set.
func (o *VirtualNetwork) HasVxlan() bool {
if o != nil && !IsNil(o.Vxlan) {
return true
}
return false
}
// SetVxlan gets a reference to the given int32 and assigns it to the Vxlan field.
func (o *VirtualNetwork) SetVxlan(v int32) {
o.Vxlan = &v
}
// GetTags returns the Tags field value if set, zero value otherwise.
func (o *VirtualNetwork) GetTags() []string {
if o == nil || IsNil(o.Tags) {
var ret []string
return ret
}
return o.Tags
}
// GetTagsOk returns a tuple with the Tags field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *VirtualNetwork) GetTagsOk() ([]string, bool) {
if o == nil || IsNil(o.Tags) {
return nil, false
}
return o.Tags, true
}
// HasTags returns a boolean if a field has been set.
func (o *VirtualNetwork) HasTags() bool {
if o != nil && !IsNil(o.Tags) {
return true
}
return false
}
// SetTags gets a reference to the given []string and assigns it to the Tags field.
func (o *VirtualNetwork) SetTags(v []string) {
o.Tags = v
}
func (o VirtualNetwork) MarshalJSON() ([]byte, error) {
toSerialize, err := o.ToMap()
if err != nil {
return []byte{}, err
}
return json.Marshal(toSerialize)
}
func (o VirtualNetwork) ToMap() (map[string]interface{}, error) {
toSerialize := map[string]interface{}{}
if !IsNil(o.AssignedTo) {
toSerialize["assigned_to"] = o.AssignedTo
}
if !IsNil(o.AssignedToVirtualCircuit) {
toSerialize["assigned_to_virtual_circuit"] = o.AssignedToVirtualCircuit
}
if !IsNil(o.Description) {
toSerialize["description"] = o.Description
}
if !IsNil(o.Facility) {
toSerialize["facility"] = o.Facility
}
if !IsNil(o.Href) {
toSerialize["href"] = o.Href
}
if !IsNil(o.CreatedAt) {
toSerialize["created_at"] = o.CreatedAt
}
if !IsNil(o.Id) {
toSerialize["id"] = o.Id
}
if !IsNil(o.Instances) {
toSerialize["instances"] = o.Instances
}
if !IsNil(o.MetalGateways) {
toSerialize["metal_gateways"] = o.MetalGateways
}
if !IsNil(o.Metro) {
toSerialize["metro"] = o.Metro
}
if !IsNil(o.MetroCode) {
toSerialize["metro_code"] = o.MetroCode
}
if !IsNil(o.Vxlan) {
toSerialize["vxlan"] = o.Vxlan
}
if !IsNil(o.Tags) {
toSerialize["tags"] = o.Tags
}
for key, value := range o.AdditionalProperties {
toSerialize[key] = value
}
return toSerialize, nil
}
func (o *VirtualNetwork) UnmarshalJSON(data []byte) (err error) {
varVirtualNetwork := _VirtualNetwork{}
err = json.Unmarshal(data, &varVirtualNetwork)
if err != nil {
return err
}
*o = VirtualNetwork(varVirtualNetwork)
additionalProperties := make(map[string]interface{})
if err = json.Unmarshal(data, &additionalProperties); err == nil {
delete(additionalProperties, "assigned_to")
delete(additionalProperties, "assigned_to_virtual_circuit")
delete(additionalProperties, "description")
delete(additionalProperties, "facility")
delete(additionalProperties, "href")
delete(additionalProperties, "created_at")
delete(additionalProperties, "id")
delete(additionalProperties, "instances")
delete(additionalProperties, "metal_gateways")
delete(additionalProperties, "metro")
delete(additionalProperties, "metro_code")
delete(additionalProperties, "vxlan")
delete(additionalProperties, "tags")
o.AdditionalProperties = additionalProperties
}
return err
}
type NullableVirtualNetwork struct {
value *VirtualNetwork
isSet bool
}
func (v NullableVirtualNetwork) Get() *VirtualNetwork {
return v.value
}
func (v *NullableVirtualNetwork) Set(val *VirtualNetwork) {
v.value = val
v.isSet = true
}
func (v NullableVirtualNetwork) IsSet() bool {
return v.isSet
}
func (v *NullableVirtualNetwork) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableVirtualNetwork(val *VirtualNetwork) *NullableVirtualNetwork {
return &NullableVirtualNetwork{value: val, isSet: true}
}
func (v NullableVirtualNetwork) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableVirtualNetwork) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}