gophercloud: github.com/rackspace/gophercloud/openstack/networking/v2/extensions/lbaas_v2/listeners Index | Files

package listeners

import "github.com/rackspace/gophercloud/openstack/networking/v2/extensions/lbaas_v2/listeners"

Index

Package Files

requests.go results.go urls.go

func ExtractListeners Uses

func ExtractListeners(page pagination.Page) ([]Listener, error)

ExtractListeners accepts a Page struct, specifically a ListenerPage struct, and extracts the elements into a slice of Listener 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 routers. It accepts a ListOpts struct, which allows you to filter and sort the returned collection for greater efficiency.

Default policy settings return only those routers 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.

var (
    Up   AdminState = &iTrue
    Down AdminState = &iFalse
)

Convenience vars for AdminStateUp values.

type CreateOpts Uses

type CreateOpts listenerOpts

CreateOpts is the common options struct used in this package's Create operation.

func (CreateOpts) ToListenerCreateMap Uses

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

ToListenerCreateMap casts a CreateOpts struct to a map.

type CreateOptsBuilder Uses

type CreateOptsBuilder interface {
    ToListenerCreateMap() (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 CreateOpts) CreateResult

Create is an operation which provisions a new Listeners based on the configuration defined in the CreateOpts struct. Once the request is validated and progress has started on the provisioning process, a CreateResult will be returned.

Users with an admin role can create Listeners on behalf of other tenants by specifying a TenantID attribute different than their own.

func (CreateResult) Extract Uses

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

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

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 Listeners based on its unique ID.

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 Listeners based on its unique ID.

func (GetResult) Extract Uses

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

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

type ListOpts Uses

type ListOpts struct {
    ID              string `q:"id"`
    Name            string `q:"name"`
    AdminStateUp    *bool  `q:"admin_state_up"`
    TenantID        string `q:"tenant_id"`
    LoadbalancerID  string `q:"loadbalancer_id"`
    DefaultPoolID   string `q:"default_pool_id"`
    Protocol        string `q:"protocol"`
    ProtocolPort    int    `q:"protocol_port"`
    ConnectionLimit int    `q:"connection_limit"`
    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 floating IP attributes you want to see returned. SortKey allows you to sort by a particular listener attribute. SortDir sets the direction, and is either `asc' or `desc'. Marker and Limit are used for pagination.

func (ListOpts) ToListenerListQuery Uses

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

ToListenerListQuery formats a ListOpts into a query string.

type ListOptsBuilder Uses

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

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

type Listener Uses

type Listener struct {
    // The unique ID for the Listener.
    ID  string `mapstructure:"id" json:"id"`

    // Owner of the Listener. Only an admin user can specify a tenant ID other than its own.
    TenantID string `mapstructure:"tenant_id" json:"tenant_id"`

    // Human-readable name for the Listener. Does not have to be unique.
    Name string `mapstructure:"name" json:"name"`

    // Human-readable description for the Listener.
    Description string `mapstructure:"description" json:"description"`

    // The protocol to loadbalance. A valid value is TCP, HTTP, or HTTPS.
    Protocol string `mapstructure:"protocol" json:"protocol"`

    // The port on which to listen to client traffic that is associated with the
    // Loadbalancer. A valid value is from 0 to 65535.
    ProtocolPort int `mapstructure:"protocol_port" json:"protocol_port"`

    // The UUID of default pool. Must have compatible protocol with listener.
    DefaultPoolID string `mapstructure:"default_pool_id" json:"default_pool_id"`

    // A list of load balancer IDs.
    Loadbalancers []LoadBalancerID `mapstructure:"loadbalancers" json:"loadbalancers"`

    // The maximum number of connections allowed for the Loadbalancer. Default is -1,
    // meaning no limit.
    ConnLimit int `mapstructure:"connection_limit" json:"connection_limit"`

    // The list of references to TLS secrets.
    SniContainerRefs []string `mapstructure:"sni_container_refs" json:"sni_container_refs"`

    // Optional. A reference to a container of TLS secrets.
    DefaultTlsContainerRef string `mapstructure:"default_tls_container_ref" json:"default_tls_container_ref"`

    // The administrative state of the Listener. A valid value is true (UP) or false (DOWN).
    AdminStateUp bool `mapstructure:"admin_state_up" json:"admin_state_up"`

    Pools []pools.Pool `mapstructure:"pools" json:"pools"`
}

Listener is the primary load balancing configuration object that specifies the loadbalancer and port on which client traffic is received, as well as other details such as the load balancing method to be use, protocol, etc.

type ListenerPage Uses

type ListenerPage struct {
    pagination.LinkedPageBase
}

ListenerPage is the page returned by a pager when traversing over a collection of routers.

func (ListenerPage) IsEmpty Uses

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

IsEmpty checks whether a RouterPage struct is empty.

func (ListenerPage) NextPageURL Uses

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

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

type LoadBalancerID struct {
    ID string `mapstructure:"id" json:"id"`
}

type Protocol Uses

type Protocol string
const (
    ProtocolTCP   Protocol = "TCP"
    ProtocolHTTP  Protocol = "HTTP"
    ProtocolHTTPS Protocol = "HTTPS"
)

Supported attributes for create/update operations.

type UpdateOpts Uses

type UpdateOpts listenerOpts

UpdateOpts is the common options struct used in this package's Update operation.

func (UpdateOpts) ToListenerUpdateMap Uses

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

ToListenerUpdateMap casts a UpdateOpts struct to a map.

type UpdateOptsBuilder Uses

type UpdateOptsBuilder interface {
    ToListenerUpdateMap() (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 UpdateOpts) UpdateResult

Update is an operation which modifies the attributes of the specified Listener.

func (UpdateResult) Extract Uses

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

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

Package listeners imports 5 packages (graph) and is imported by 26 packages. Updated 2016-07-23. Refresh now. Tools for package owners.