Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func List ¶
func List(c *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager
List returns a Pager which allows you to iterate over a collection of firewall groups. It accepts a ListOpts struct, which allows you to filter and sort the returned collection for greater efficiency.
Default group settings return only those firewall groups that are owned by the tenant who submits the request, unless an admin user submits the request.
Types ¶
type CreateOpts ¶
type CreateOpts struct { ID string `json:"id,omitempty"` TenantID string `json:"tenant_id,omitempty"` Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` IngressFirewallPolicyID string `json:"ingress_firewall_policy_id,omitempty"` EgressFirewallPolicyID string `json:"egress_firewall_policy_id,omitempty"` AdminStateUp *bool `json:"admin_state_up,omitempty"` Ports []string `json:"ports,omitempty"` ProjectID string `json:"project_id,omitempty"` }
CreateOpts contains all the values needed to create a new firewall group.
func (CreateOpts) ToFirewallGroupCreateMap ¶
func (opts CreateOpts) ToFirewallGroupCreateMap() (map[string]interface{}, error)
ToFirewallGroupCreateMap casts a CreateOpts struct to a map.
type CreateOptsBuilder ¶
CreateOptsBuilder is the interface options structs have to satisfy in order to be used in the main Create operation in this package. Since many extensions decorate or modify the common logic, it is useful for them to satisfy a basic interface in order for them to be used.
type CreateResult ¶
type CreateResult struct {
// contains filtered or unexported fields
}
CreateResult represents the result of a create operation.
func Create ¶
func Create(c *gophercloud.ServiceClient, opts CreateOptsBuilder) (r CreateResult)
Create accepts a CreateOpts struct and uses the values to create a new firewall group
type DeleteResult ¶
type DeleteResult struct {
gophercloud.ErrResult
}
DeleteResult represents the result of a delete operation.
func Delete ¶
func Delete(c *gophercloud.ServiceClient, id string) (r DeleteResult)
Delete will permanently delete a particular firewall group based on its unique ID.
type GetResult ¶
type GetResult struct {
// contains filtered or unexported fields
}
GetResult represents the result of a get operation.
func Get ¶
func Get(c *gophercloud.ServiceClient, id string) (r GetResult)
Get retrieves a particular firewall group based on its unique ID.
type Group ¶
type Group struct { ID string `json:"id"` TenantID string `json:"tenant_id"` Name string `json:"name"` Description string `json:"description"` IngressFirewallPolicyID string `json:"ingress_firewall_policy_id"` EgressFirewallPolicyID string `json:"egress_firewall_policy_id"` AdminStateUp bool `json:"admin_state_up"` Ports []string `json:"ports"` Status string `json:"status"` ProjectID string `json:"project_id"` }
Group is a firewall group.
func ExtractGroups ¶
func ExtractGroups(r pagination.Page) ([]Group, error)
ExtractGroups accepts a Page struct, specifically a GroupPage struct, and extracts the elements into a slice of Group structs. In other words, a generic collection is mapped into a relevant slice.
type GroupPage ¶
type GroupPage struct {
pagination.LinkedPageBase
}
GroupPage is the page returned by a pager when traversing over a collection of firewall groups.
func (GroupPage) NextPageURL ¶
NextPageURL is invoked when a paginated collection of firewall groups has reached the end of a page and the pager seeks to traverse over a new one. In order to do this, it needs to construct the next page's URL.
type ListOpts ¶
type ListOpts struct { TenantID string `q:"tenant_id"` Name string `q:"name"` Description string `q:"description"` IngressFirewallPolicyID string `q:"ingress_firewall_policy_id"` EgressFirewallPolicyID string `q:"egress_firewall_policy_id"` AdminStateUp *bool `q:"admin_state_up"` Ports *[]string `q:"ports"` Status string `q:"status"` ID string `q:"id"` ProjectID string `q:"project_id"` Limit int `q:"limit"` Marker string `q:"marker"` SortKey string `q:"sort_key"` SortDir string `q:"sort_dir"` }
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 firewall group attributes you want to see returned. SortKey allows you to sort by a particular firewall group attribute. SortDir sets the direction, and is either `asc' or `desc'. Marker and Limit are used for pagination.
func (ListOpts) ToGroupListQuery ¶
ToGroupListQuery formats a ListOpts into a query string.
type ListOptsBuilder ¶
ListOptsBuilder allows extensions to add additional parameters to the List request.
type UpdateOpts ¶
type UpdateOpts struct { Name *string `json:"name,omitempty"` Description *string `json:"description,omitempty"` IngressFirewallPolicyID *string `json:"ingress_firewall_policy_id,omitempty"` EgressFirewallPolicyID *string `json:"egress_firewall_policy_id,omitempty"` AdminStateUp *bool `json:"admin_state_up,omitempty"` Ports *[]string `json:"ports,omitempty"` }
UpdateOpts contains the values used when updating a firewall group.
func (UpdateOpts) ToFirewallGroupUpdateMap ¶
func (opts UpdateOpts) ToFirewallGroupUpdateMap() (map[string]interface{}, error)
ToFirewallGroupUpdateMap casts a CreateOpts struct to a map.
type UpdateOptsBuilder ¶
UpdateOptsBuilder is the interface options structs have to satisfy in order to be used in the main Update operation in this package. Since many extensions decorate or modify the common logic, it is useful for them to satisfy a basic interface in order for them to be used.
type UpdateResult ¶
type UpdateResult struct {
// contains filtered or unexported fields
}
UpdateResult represents the result of an update operation.
func Update ¶
func Update(c *gophercloud.ServiceClient, id string, opts UpdateOptsBuilder) (r UpdateResult)
Update allows firewall groups to be updated.