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
|
package services
import (
"github.com/gophercloud/gophercloud"
"github.com/gophercloud/gophercloud/pagination"
)
// CreateOptsBuilder allows extensions to add additional parameters to the
// Create request.
type CreateOptsBuilder interface {
ToServiceCreateMap() (map[string]interface{}, error)
}
// CreateOpts contains all the values needed to create a new VPN service
type CreateOpts struct {
// TenantID specifies a tenant to own the VPN service. The caller must have
// an admin role in order to set this. Otherwise, this field is left unset
// and the caller will be the owner.
TenantID string `json:"tenant_id,omitempty"`
// SubnetID is the ID of the subnet.
SubnetID string `json:"subnet_id,omitempty"`
// RouterID is the ID of the router.
RouterID string `json:"router_id" required:"true"`
// Description is the human readable description of the service.
Description string `json:"description,omitempty"`
// AdminStateUp is the administrative state of the resource, which is up (true) or down (false).
AdminStateUp *bool `json:"admin_state_up"`
// Name is the human readable name of the service.
Name string `json:"name,omitempty"`
// The ID of the flavor.
FlavorID string `json:"flavor_id,omitempty"`
}
// ToServiceCreateMap casts a CreateOpts struct to a map.
func (opts CreateOpts) ToServiceCreateMap() (map[string]interface{}, error) {
return gophercloud.BuildRequestBody(opts, "vpnservice")
}
// Create accepts a CreateOpts struct and uses the values to create a new
// VPN service.
func Create(c *gophercloud.ServiceClient, opts CreateOptsBuilder) (r CreateResult) {
b, err := opts.ToServiceCreateMap()
if err != nil {
r.Err = err
return
}
_, r.Err = c.Post(rootURL(c), b, &r.Body, nil)
return
}
// Delete will permanently delete a particular VPN service based on its
// unique ID.
func Delete(c *gophercloud.ServiceClient, id string) (r DeleteResult) {
_, r.Err = c.Delete(resourceURL(c, id), nil)
return
}
// UpdateOptsBuilder allows extensions to add additional parameters to the
// Update request.
type UpdateOptsBuilder interface {
ToServiceUpdateMap() (map[string]interface{}, error)
}
// UpdateOpts contains the values used when updating a VPN service
type UpdateOpts struct {
// Name is the human readable name of the service.
Name *string `json:"name,omitempty"`
// Description is the human readable description of the service.
Description *string `json:"description,omitempty"`
// AdminStateUp is the administrative state of the resource, which is up (true) or down (false).
AdminStateUp *bool `json:"admin_state_up,omitempty"`
}
// ToServiceUpdateMap casts aa UodateOpts struct to a map.
func (opts UpdateOpts) ToServiceUpdateMap() (map[string]interface{}, error) {
return gophercloud.BuildRequestBody(opts, "vpnservice")
}
// Update allows VPN services to be updated.
func Update(c *gophercloud.ServiceClient, id string, opts UpdateOptsBuilder) (r UpdateResult) {
b, err := opts.ToServiceUpdateMap()
if err != nil {
r.Err = err
return
}
_, r.Err = c.Put(resourceURL(c, id), b, &r.Body, &gophercloud.RequestOpts{
OkCodes: []int{200},
})
return
}
// ListOptsBuilder allows extensions to add additional parameters to the
// List request.
type ListOptsBuilder interface {
ToServiceListQuery() (string, error)
}
// ListOpts allows the filtering and sorting of paginated collections through
// the API. Filtering is achieved by passing in struct field values that map to
// the VPN service attributes you want to see returned.
type ListOpts struct {
TenantID string `q:"tenant_id"`
Name string `q:"name"`
Description string `q:"description"`
AdminStateUp *bool `q:"admin_state_up"`
Status string `q:"status"`
SubnetID string `q:"subnet_id"`
RouterID string `q:"router_id"`
ProjectID string `q:"project_id"`
ExternalV6IP string `q:"external_v6_ip"`
ExternalV4IP string `q:"external_v4_ip"`
FlavorID string `q:"flavor_id"`
}
// ToServiceListQuery formats a ListOpts into a query string.
func (opts ListOpts) ToServiceListQuery() (string, error) {
q, err := gophercloud.BuildQueryString(opts)
return q.String(), err
}
// List returns a Pager which allows you to iterate over a collection of
// VPN services. It accepts a ListOpts struct, which allows you to filter
// and sort the returned collection for greater efficiency.
func List(c *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager {
url := rootURL(c)
if opts != nil {
query, err := opts.ToServiceListQuery()
if err != nil {
return pagination.Pager{Err: err}
}
url += query
}
return pagination.NewPager(c, url, func(r pagination.PageResult) pagination.Page {
return ServicePage{pagination.LinkedPageBase{PageResult: r}}
})
}
// Get retrieves a particular VPN service based on its unique ID.
func Get(c *gophercloud.ServiceClient, id string) (r GetResult) {
_, r.Err = c.Get(resourceURL(c, id), &r.Body, nil)
return
}
|