-
Notifications
You must be signed in to change notification settings - Fork 5
/
model_ip_assignment_input.go
204 lines (161 loc) · 9.29 KB
/
model_ip_assignment_input.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
/*
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"
"fmt"
)
// checks if the IPAssignmentInput type satisfies the MappedNullable interface at compile time
var _ MappedNullable = &IPAssignmentInput{}
// IPAssignmentInput struct for IPAssignmentInput
type IPAssignmentInput struct {
Address string `json:"address"`
Customdata map[string]interface{} `json:"customdata,omitempty"`
AdditionalProperties map[string]interface{}
}
type _IPAssignmentInput IPAssignmentInput
// NewIPAssignmentInput instantiates a new IPAssignmentInput 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 NewIPAssignmentInput(address string) *IPAssignmentInput {
this := IPAssignmentInput{}
this.Address = address
return &this
}
// NewIPAssignmentInputWithDefaults instantiates a new IPAssignmentInput 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 NewIPAssignmentInputWithDefaults() *IPAssignmentInput {
this := IPAssignmentInput{}
return &this
}
// GetAddress returns the Address field value
func (o *IPAssignmentInput) GetAddress() string {
if o == nil {
var ret string
return ret
}
return o.Address
}
// GetAddressOk returns a tuple with the Address field value
// and a boolean to check if the value has been set.
func (o *IPAssignmentInput) GetAddressOk() (*string, bool) {
if o == nil {
return nil, false
}
return &o.Address, true
}
// SetAddress sets field value
func (o *IPAssignmentInput) SetAddress(v string) {
o.Address = v
}
// GetCustomdata returns the Customdata field value if set, zero value otherwise.
func (o *IPAssignmentInput) GetCustomdata() map[string]interface{} {
if o == nil || IsNil(o.Customdata) {
var ret map[string]interface{}
return ret
}
return o.Customdata
}
// GetCustomdataOk returns a tuple with the Customdata field value if set, nil otherwise
// and a boolean to check if the value has been set.
func (o *IPAssignmentInput) GetCustomdataOk() (map[string]interface{}, bool) {
if o == nil || IsNil(o.Customdata) {
return map[string]interface{}{}, false
}
return o.Customdata, true
}
// HasCustomdata returns a boolean if a field has been set.
func (o *IPAssignmentInput) HasCustomdata() bool {
if o != nil && !IsNil(o.Customdata) {
return true
}
return false
}
// SetCustomdata gets a reference to the given map[string]interface{} and assigns it to the Customdata field.
func (o *IPAssignmentInput) SetCustomdata(v map[string]interface{}) {
o.Customdata = v
}
func (o IPAssignmentInput) MarshalJSON() ([]byte, error) {
toSerialize, err := o.ToMap()
if err != nil {
return []byte{}, err
}
return json.Marshal(toSerialize)
}
func (o IPAssignmentInput) ToMap() (map[string]interface{}, error) {
toSerialize := map[string]interface{}{}
toSerialize["address"] = o.Address
if !IsNil(o.Customdata) {
toSerialize["customdata"] = o.Customdata
}
for key, value := range o.AdditionalProperties {
toSerialize[key] = value
}
return toSerialize, nil
}
func (o *IPAssignmentInput) UnmarshalJSON(data []byte) (err error) {
// This validates that all required properties are included in the JSON object
// by unmarshalling the object into a generic map with string keys and checking
// that every required field exists as a key in the generic map.
requiredProperties := []string{
"address",
}
allProperties := make(map[string]interface{})
err = json.Unmarshal(data, &allProperties)
if err != nil {
return err
}
for _, requiredProperty := range requiredProperties {
if _, exists := allProperties[requiredProperty]; !exists {
return fmt.Errorf("no value given for required property %v", requiredProperty)
}
}
varIPAssignmentInput := _IPAssignmentInput{}
err = json.Unmarshal(data, &varIPAssignmentInput)
if err != nil {
return err
}
*o = IPAssignmentInput(varIPAssignmentInput)
additionalProperties := make(map[string]interface{})
if err = json.Unmarshal(data, &additionalProperties); err == nil {
delete(additionalProperties, "address")
delete(additionalProperties, "customdata")
o.AdditionalProperties = additionalProperties
}
return err
}
type NullableIPAssignmentInput struct {
value *IPAssignmentInput
isSet bool
}
func (v NullableIPAssignmentInput) Get() *IPAssignmentInput {
return v.value
}
func (v *NullableIPAssignmentInput) Set(val *IPAssignmentInput) {
v.value = val
v.isSet = true
}
func (v NullableIPAssignmentInput) IsSet() bool {
return v.isSet
}
func (v *NullableIPAssignmentInput) Unset() {
v.value = nil
v.isSet = false
}
func NewNullableIPAssignmentInput(val *IPAssignmentInput) *NullableIPAssignmentInput {
return &NullableIPAssignmentInput{value: val, isSet: true}
}
func (v NullableIPAssignmentInput) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullableIPAssignmentInput) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}