ruletypes

Documentation

Overview

Package ruletypes contains functionality for working with Neutron 'quality of service' rule-type resources.

Example of Listing QoS rule types

page, err := ruletypes.ListRuleTypes(client).AllPages()
if err != nil {
	return
}

rules, err := ruletypes.ExtractRuleTypes(page)
if err != nil {
	return
}

fmt.Printf("%v <- Rule Types\n", rules)

Example of Getting a single QoS rule type by it's name

ruleTypeName := "bandwidth_limit"

ruleType, err := ruletypes.Get(networkClient, ruleTypeName).Extract()
if err != nil {
    panic(err)
}

fmt.Printf("%+v\n", ruleTypeName)

Index

• func ListRuleTypes(c *gophercloud.ServiceClient) (result pagination.Pager)
• type Driver
• type GetResult
  • func GetRuleType(c *gophercloud.ServiceClient, name string) (r GetResult)
  • func (r GetResult) Extract() (*RuleType, error)
• type ListRuleTypesPage
  • func (r ListRuleTypesPage) IsEmpty() (bool, error)
• type RuleType
  • func ExtractRuleTypes(r pagination.Page) ([]RuleType, error)
• type SupportedParameter

Functions

func ListRuleTypes

func ListRuleTypes(c *gophercloud.ServiceClient) (result pagination.Pager)

ListRuleTypes returns the list of rule types from the server

Types

type Driver

type Driver struct {
	Name                string               `json:"name"`
	SupportedParameters []SupportedParameter `json:"supported_parameters"`
}

Driver represents a single QoS driver.

type GetResult

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

GetResult represents the result of a get operation. Call its Extract method to interpret it as a RuleType.

func GetRuleType

func GetRuleType(c *gophercloud.ServiceClient, name string) (r GetResult)

GetRuleType retrieves a specific QoS RuleType based on its name.

func (GetResult) Extract

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

type ListRuleTypesPage

type ListRuleTypesPage struct {
	pagination.SinglePageBase
}

func (ListRuleTypesPage) IsEmpty

func (r ListRuleTypesPage) IsEmpty() (bool, error)

type RuleType

type RuleType struct {
	Type    string   `json:"type"`
	Drivers []Driver `json:"drivers"`
}

RuleType represents a single QoS rule type.

func ExtractRuleTypes

func ExtractRuleTypes(r pagination.Page) ([]RuleType, error)

type SupportedParameter

type SupportedParameter struct {
	ParameterName   string      `json:"parameter_name"`
	ParameterType   string      `json:"parameter_type"`
	ParameterValues interface{} `json:"parameter_values"`
}

SupportedParameter represents a single set of supported parameters for a some QoS driver's .