Documentation ¶
Index ¶
- func List(c *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager
- type AdminState
- type CreateOpts
- type CreateOptsBuilder
- type CreateResult
- type DeleteResult
- type GetResult
- type ListOpts
- type ListOptsBuilder
- type LoadBalancer
- type LoadbalancerPage
- type StatusTree
- type UpdateOpts
- type UpdateOptsBuilder
- type UpdateResult
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 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.
Types ¶
type AdminState ¶
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 ¶
type CreateOpts loadbalancerOpts
CreateOpts is the common options struct used in this package's Create operation.
func (CreateOpts) ToLoadbalancerCreateMap ¶
func (opts CreateOpts) ToLoadbalancerCreateMap() (map[string]interface{}, error)
ToLoadbalancerCreateMap 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 CreateOpts) CreateResult
Create is an operation which provisions a new loadbalancer 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 loadbalancers on behalf of other tenants by specifying a TenantID attribute different than their own.
func (CreateResult) Extract ¶
func (r CreateResult) Extract() (*LoadBalancer, error)
Extract is a function that accepts a result and extracts a router.
func (CreateResult) ExtractStatuses ¶
func (r CreateResult) ExtractStatuses() (*StatusTree, error)
Extract is a function that accepts a result and extracts a Loadbalancer.
type DeleteResult ¶
type DeleteResult struct {
gophercloud.ErrResult
}
DeleteResult represents the result of a delete operation.
func Delete ¶
func Delete(c *gophercloud.ServiceClient, id string) DeleteResult
Delete will permanently delete a particular Loadbalancer 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) GetResult
Get retrieves a particular Loadbalancer based on its unique ID.
func GetStatuses ¶
func GetStatuses(c *gophercloud.ServiceClient, id string) GetResult
func (GetResult) Extract ¶
func (r GetResult) Extract() (*LoadBalancer, error)
Extract is a function that accepts a result and extracts a router.
func (GetResult) ExtractStatuses ¶
func (r GetResult) ExtractStatuses() (*StatusTree, error)
Extract is a function that accepts a result and extracts a Loadbalancer.
type ListOpts ¶
type ListOpts struct { Description string `q:"description"` AdminStateUp *bool `q:"admin_state_up"` TenantID string `q:"tenant_id"` ProvisioningStatus string `q:"provisioning_status"` VipAddress string `q:"vip_address"` VipSubnetID string `q:"vip_subnet_id"` ID string `q:"id"` OperatingStatus string `q:"operating_status"` Name string `q:"name"` Flavor string `q:"flavor"` Provider string `q:"provider"` 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 Loadbalancer attributes you want to see returned. SortKey allows you to sort by a particular attribute. SortDir sets the direction, and is either `asc' or `desc'. Marker and Limit are used for pagination.
func (ListOpts) ToLoadbalancerListQuery ¶
ToLoadbalancerListQuery formats a ListOpts into a query string.
type ListOptsBuilder ¶
ListOptsBuilder allows extensions to add additional parameters to the List request.
type LoadBalancer ¶
type LoadBalancer struct { // Human-readable description for the Loadbalancer. Description string `mapstructure:"description" json:"description"` // The administrative state of the Loadbalancer. A valid value is true (UP) or false (DOWN). AdminStateUp bool `mapstructure:"admin_state_up" json:"admin_state_up"` // Owner of the LoadBalancer. Only an admin user can specify a tenant ID other than its own. TenantID string `mapstructure:"tenant_id" json:"tenant_id"` // The provisioning status of the LoadBalancer. This value is ACTIVE, PENDING_CREATE or ERROR. ProvisioningStatus string `mapstructure:"provisioning_status" json:"provisioning_status"` // The IP address of the Loadbalancer. VipAddress string `mapstructure:"vip_address" json:"vip_address"` // The UUID of the subnet on which to allocate the virtual IP for the Loadbalancer address. VipSubnetID string `mapstructure:"vip_subnet_id" json:"vip_subnet_id"` // The unique ID for the LoadBalancer. ID string `mapstructure:"id" json:"id"` // The operating status of the LoadBalancer. This value is ONLINE or OFFLINE. OperatingStatus string `mapstructure:"operating_status" json:"operating_status"` // Human-readable name for the LoadBalancer. Does not have to be unique. Name string `mapstructure:"name" json:"name"` // The UUID of a flavor if set. Flavor string `mapstructure:"flavor" json:"flavor"` // The name of the provider. Provider string `mapstructure:"provider" json:"provider"` Listeners []listeners.Listener `mapstructure:"listeners" json:"listeners"` }
LoadBalancer is the primary load balancing configuration object that specifies the virtual IP address on which client traffic is received, as well as other details such as the load balancing method to be use, protocol, etc.
func ExtractLoadbalancers ¶
func ExtractLoadbalancers(page pagination.Page) ([]LoadBalancer, error)
ExtractLoadbalancers accepts a Page struct, specifically a LoadbalancerPage struct, and extracts the elements into a slice of LoadBalancer structs. In other words, a generic collection is mapped into a relevant slice.
type LoadbalancerPage ¶
type LoadbalancerPage struct {
pagination.LinkedPageBase
}
LoadbalancerPage is the page returned by a pager when traversing over a collection of routers.
func (LoadbalancerPage) IsEmpty ¶
func (p LoadbalancerPage) IsEmpty() (bool, error)
IsEmpty checks whether a RouterPage struct is empty.
func (LoadbalancerPage) NextPageURL ¶
func (p LoadbalancerPage) 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 StatusTree ¶
type StatusTree struct {
Loadbalancer *LoadBalancer `mapstructure:"loadbalancer" json:"loadbalancer"`
}
type UpdateOpts ¶
type UpdateOpts loadbalancerOpts
UpdateOpts is the common options struct used in this package's Update operation.
func (UpdateOpts) ToLoadbalancerUpdateMap ¶
func (opts UpdateOpts) ToLoadbalancerUpdateMap() (map[string]interface{}, error)
ToLoadbalancerUpdateMap casts a UpdateOpts 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 UpdateOpts) UpdateResult
Update is an operation which modifies the attributes of the specified Loadbalancer.
func (UpdateResult) Extract ¶
func (r UpdateResult) Extract() (*LoadBalancer, error)
Extract is a function that accepts a result and extracts a router.
func (UpdateResult) ExtractStatuses ¶
func (r UpdateResult) ExtractStatuses() (*StatusTree, error)
Extract is a function that accepts a result and extracts a Loadbalancer.