Newer
Older
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
// Copyright 2017 The go-netbox Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Code generated by generate_functions.go. DO NOT EDIT.
package netbox
import (
"encoding/json"
"fmt"
"net/http"
)
// VRFsService is used in a Client to access NetBox's ipam/vrfs API methods.
type VRFsService struct {
c *Client
}
// Get retrieves an VRF object from NetBox by its ID.
func (s *VRFsService) Get(id int) (*VRF, error) {
req, err := s.c.NewRequest(
http.MethodGet,
fmt.Sprintf("api/ipam/vrfs/%d/", id),
nil,
)
if err != nil {
return nil, err
}
t := new(VRF)
err = s.c.Do(req, t)
if err != nil {
return nil, err
}
return t, nil
}
// List returns a Page associated with an NetBox API Endpoint.
func (s *VRFsService) List(options *ListVRFOptions) *Page {
return NewPage(s.c, "api/ipam/vrfs/", options)
}
// Extract retrives a list of VRF objects from page.
func (s *VRFsService) Extract(page *Page) ([]*VRF, error) {
if err := page.Err(); err != nil {
return nil, err
}
var groups []*VRF
if err := json.Unmarshal(page.data.Results, &groups); err != nil {
return nil, err
}
return groups, nil
}
// Create creates a new VRF object in NetBox and returns the ID of the new object.
func (s *VRFsService) Create(data *VRF) (int, error) {
req, err := s.c.NewJSONRequest(http.MethodPost, "api/ipam/vrfs/", nil, data)
if err != nil {
return 0, err
}
g := new(writableVRF)
err = s.c.Do(req, g)
if err != nil {
return 0, err
}
return g.ID, nil
}
// Update changes an existing VRF object in NetBox, and returns the ID of the new object.
func (s *VRFsService) Update(data *VRF) (int, error) {
req, err := s.c.NewJSONRequest(
http.MethodPatch,
fmt.Sprintf("api/ipam/vrfs/%d/", data.ID),
nil,
data,
)
if err != nil {
return 0, err
}
// g is just used to verify correct api result.
// data is not changed, because the g is not the full representation that one would
// get with Get. But if the response was unmarshaled into writableVRF correctly,
// everything went fine, and we do not need to update data.
g := new(writableVRF)
err = s.c.Do(req, g)
if err != nil {
return 0, err
}
return g.ID, nil
}
// Delete deletes an existing VRF object from NetBox.
func (s *VRFsService) Delete(data *VRF) error {
req, err := s.c.NewRequest(
http.MethodDelete,
fmt.Sprintf("api/ipam/vrfs/%d/", data.ID),
nil,
)
if err != nil {
return err
}
return s.c.Do(req, nil)
}