gophercloud: github.com/rackspace/gophercloud/openstack/networking/v2/extensions/fwaas/firewalls Index | Files

package firewalls

import "github.com/rackspace/gophercloud/openstack/networking/v2/extensions/fwaas/firewalls"

Index

Package Files

errors.go requests.go results.go urls.go

Variables

var (
    Up   AdminState = &iTrue
    Down AdminState = &iFalse
    Yes  Shared     = &iTrue
    No   Shared     = &iFalse
)

Convenience vars for AdminStateUp and Shared values.

func ExtractFirewalls Uses

func ExtractFirewalls(page pagination.Page) ([]Firewall, error)

ExtractFirewalls accepts a Page struct, specifically a RouterPage struct, and extracts the elements into a slice of Router structs. In other words, a generic collection is mapped into a relevant slice.

func List Uses

func List(c *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager

List returns a Pager which allows you to iterate over a collection of firewalls. It accepts a ListOpts struct, which allows you to filter and sort the returned collection for greater efficiency.

Default policy settings return only those firewalls that are owned by the tenant who submits the request, unless an admin user submits the request.

type AdminState Uses

type AdminState *bool

AdminState gives users a solid type to work with for create and update operations. It is recommended that users use the `Up` and `Down` enums.

type CreateOpts Uses

type CreateOpts struct {
    // Only required if the caller has an admin role and wants to create a firewall
    // for another tenant.
    TenantID     string
    Name         string
    Description  string
    AdminStateUp *bool
    Shared       *bool
    PolicyID     string
}

CreateOpts contains all the values needed to create a new firewall.

func (CreateOpts) ToFirewallCreateMap Uses

func (opts CreateOpts) ToFirewallCreateMap() (map[string]interface{}, error)

ToFirewallCreateMap casts a CreateOpts struct to a map.

type CreateOptsBuilder Uses

type CreateOptsBuilder interface {
    ToFirewallCreateMap() (map[string]interface{}, error)
}

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 Uses

type CreateResult struct {
    // contains filtered or unexported fields
}

CreateResult represents the result of a create operation.

func Create Uses

func Create(c *gophercloud.ServiceClient, opts CreateOptsBuilder) CreateResult

Create accepts a CreateOpts struct and uses the values to create a new firewall

func (CreateResult) Extract Uses

func (r CreateResult) Extract() (*Firewall, error)

Extract is a function that accepts a result and extracts a firewall.

type DeleteResult Uses

type DeleteResult struct {
    gophercloud.ErrResult
}

DeleteResult represents the result of a delete operation.

func Delete Uses

func Delete(c *gophercloud.ServiceClient, id string) DeleteResult

Delete will permanently delete a particular firewall based on its unique ID.

type Firewall Uses

type Firewall struct {
    ID           string `json:"id" mapstructure:"id"`
    Name         string `json:"name" mapstructure:"name"`
    Description  string `json:"description" mapstructure:"description"`
    AdminStateUp bool   `json:"admin_state_up" mapstructure:"admin_state_up"`
    Status       string `json:"status" mapstructure:"status"`
    PolicyID     string `json:"firewall_policy_id" mapstructure:"firewall_policy_id"`
    TenantID     string `json:"tenant_id" mapstructure:"tenant_id"`
}

type FirewallPage Uses

type FirewallPage struct {
    pagination.LinkedPageBase
}

FirewallPage is the page returned by a pager when traversing over a collection of firewalls.

func (FirewallPage) IsEmpty Uses

func (p FirewallPage) IsEmpty() (bool, error)

IsEmpty checks whether a FirewallPage struct is empty.

func (FirewallPage) NextPageURL Uses

func (p FirewallPage) NextPageURL() (string, error)

NextPageURL is invoked when a paginated collection of firewalls 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 GetResult Uses

type GetResult struct {
    // contains filtered or unexported fields
}

GetResult represents the result of a get operation.

func Get Uses

func Get(c *gophercloud.ServiceClient, id string) GetResult

Get retrieves a particular firewall based on its unique ID.

func (GetResult) Extract Uses

func (r GetResult) Extract() (*Firewall, error)

Extract is a function that accepts a result and extracts a firewall.

type ListOpts Uses

type ListOpts struct {
    TenantID     string `q:"tenant_id"`
    Name         string `q:"name"`
    Description  string `q:"description"`
    AdminStateUp bool   `q:"admin_state_up"`
    Shared       bool   `q:"shared"`
    PolicyID     string `q:"firewall_policy_id"`
    ID           string `q:"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 attributes you want to see returned. SortKey allows you to sort by a particular firewall attribute. SortDir sets the direction, and is either `asc' or `desc'. Marker and Limit are used for pagination.

func (ListOpts) ToFirewallListQuery Uses

func (opts ListOpts) ToFirewallListQuery() (string, error)

ToFirewallListQuery formats a ListOpts into a query string.

type ListOptsBuilder Uses

type ListOptsBuilder interface {
    ToFirewallListQuery() (string, error)
}

ListOptsBuilder allows extensions to add additional parameters to the List request.

type Shared Uses

type Shared *bool

Shared gives users a solid type to work with for create and update operations. It is recommended that users use the `Yes` and `No` enums.

type UpdateOpts Uses

type UpdateOpts struct {
    // Name of the firewall.
    Name         string
    Description  string
    AdminStateUp *bool
    Shared       *bool
    PolicyID     string
}

UpdateOpts contains the values used when updating a firewall.

func (UpdateOpts) ToFirewallUpdateMap Uses

func (opts UpdateOpts) ToFirewallUpdateMap() (map[string]interface{}, error)

ToFirewallUpdateMap casts a CreateOpts struct to a map.

type UpdateOptsBuilder Uses

type UpdateOptsBuilder interface {
    ToFirewallUpdateMap() (map[string]interface{}, error)
}

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 Uses

type UpdateResult struct {
    // contains filtered or unexported fields
}

UpdateResult represents the result of an update operation.

func Update Uses

func Update(c *gophercloud.ServiceClient, id string, opts UpdateOptsBuilder) UpdateResult

Update allows firewalls to be updated.

func (UpdateResult) Extract Uses

func (r UpdateResult) Extract() (*Firewall, error)

Extract is a function that accepts a result and extracts a firewall.

Package firewalls imports 4 packages (graph) and is imported by 34 packages. Updated 2016-07-20. Refresh now. Tools for package owners.